Reference documentation and code samples for the Google Cloud Network Security V1beta1 Client class NetworkSecurityClient.
Service Description: Network Security API provides resources to configure authentication and authorization policies. Refer to per API resource documentation for more information.
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:
$networkSecurityClient = new NetworkSecurityClient();
try {
$formattedParent = $networkSecurityClient->locationName('[PROJECT]', '[LOCATION]');
$authorizationPolicyId = 'authorization_policy_id';
$authorizationPolicy = new AuthorizationPolicy();
$operationResponse = $networkSecurityClient->createAuthorizationPolicy($formattedParent, $authorizationPolicyId, $authorizationPolicy);
$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 = $networkSecurityClient->createAuthorizationPolicy($formattedParent, $authorizationPolicyId, $authorizationPolicy);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $networkSecurityClient->resumeOperation($operationName, 'createAuthorizationPolicy');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$networkSecurityClient->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.
Namespace
Google \ Cloud \ NetworkSecurity \ V1beta1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
createAuthorizationPolicy
Creates a new AuthorizationPolicy in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The parent resource of the AuthorizationPolicy. Must be in the
format |
authorizationPolicyId |
string
Required. Short name of the AuthorizationPolicy 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". |
authorizationPolicy |
Google\Cloud\NetworkSecurity\V1beta1\AuthorizationPolicy
Required. AuthorizationPolicy resource to be created. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1beta1\AuthorizationPolicy;
use Google\Cloud\NetworkSecurity\V1beta1\AuthorizationPolicy\Action;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent resource of the AuthorizationPolicy. Must be in the
* format `projects/{project}/locations/{location}`. Please see
* {@see NetworkSecurityClient::locationName()} for help formatting this field.
* @param string $authorizationPolicyId Short name of the AuthorizationPolicy 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 $authorizationPolicyName Name of the AuthorizationPolicy resource. It matches pattern
* `projects/{project}/locations/{location}/authorizationPolicies/<authorization_policy>`.
* @param int $authorizationPolicyAction The action to take when a rule match is found. Possible values
* are "ALLOW" or "DENY".
*/
function create_authorization_policy_sample(
string $formattedParent,
string $authorizationPolicyId,
string $authorizationPolicyName,
int $authorizationPolicyAction
): void {
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Prepare any non-scalar elements to be passed along with the request.
$authorizationPolicy = (new AuthorizationPolicy())
->setName($authorizationPolicyName)
->setAction($authorizationPolicyAction);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $networkSecurityClient->createAuthorizationPolicy(
$formattedParent,
$authorizationPolicyId,
$authorizationPolicy
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AuthorizationPolicy $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 = NetworkSecurityClient::locationName('[PROJECT]', '[LOCATION]');
$authorizationPolicyId = '[AUTHORIZATION_POLICY_ID]';
$authorizationPolicyName = '[NAME]';
$authorizationPolicyAction = Action::ACTION_UNSPECIFIED;
create_authorization_policy_sample(
$formattedParent,
$authorizationPolicyId,
$authorizationPolicyName,
$authorizationPolicyAction
);
}
createClientTlsPolicy
Creates a new ClientTlsPolicy in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The parent resource of the ClientTlsPolicy. Must be in
the format |
clientTlsPolicyId |
string
Required. Short name of the ClientTlsPolicy 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. "client_mtls_policy". |
clientTlsPolicy |
Google\Cloud\NetworkSecurity\V1beta1\ClientTlsPolicy
Required. ClientTlsPolicy resource to be created. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1beta1\ClientTlsPolicy;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent resource of the ClientTlsPolicy. Must be in
* the format `projects/*/locations/{location}`. Please see
* {@see NetworkSecurityClient::locationName()} for help formatting this field.
* @param string $clientTlsPolicyId Short name of the ClientTlsPolicy 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.
* "client_mtls_policy".
* @param string $clientTlsPolicyName Name of the ClientTlsPolicy resource. It matches the pattern
* `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}`
*/
function create_client_tls_policy_sample(
string $formattedParent,
string $clientTlsPolicyId,
string $clientTlsPolicyName
): void {
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Prepare any non-scalar elements to be passed along with the request.
$clientTlsPolicy = (new ClientTlsPolicy())
->setName($clientTlsPolicyName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $networkSecurityClient->createClientTlsPolicy(
$formattedParent,
$clientTlsPolicyId,
$clientTlsPolicy
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ClientTlsPolicy $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 = NetworkSecurityClient::locationName('[PROJECT]', '[LOCATION]');
$clientTlsPolicyId = '[CLIENT_TLS_POLICY_ID]';
$clientTlsPolicyName = '[NAME]';
create_client_tls_policy_sample($formattedParent, $clientTlsPolicyId, $clientTlsPolicyName);
}
createServerTlsPolicy
Creates a new ServerTlsPolicy in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The parent resource of the ServerTlsPolicy. Must be in
the format |
serverTlsPolicyId |
string
Required. Short name of the ServerTlsPolicy 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. "server_mtls_policy". |
serverTlsPolicy |
Google\Cloud\NetworkSecurity\V1beta1\ServerTlsPolicy
Required. ServerTlsPolicy resource to be created. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
use Google\Cloud\NetworkSecurity\V1beta1\ServerTlsPolicy;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent resource of the ServerTlsPolicy. Must be in
* the format `projects/*/locations/{location}`. Please see
* {@see NetworkSecurityClient::locationName()} for help formatting this field.
* @param string $serverTlsPolicyId Short name of the ServerTlsPolicy 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.
* "server_mtls_policy".
* @param string $serverTlsPolicyName Name of the ServerTlsPolicy resource. It matches the pattern
* `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`
*/
function create_server_tls_policy_sample(
string $formattedParent,
string $serverTlsPolicyId,
string $serverTlsPolicyName
): void {
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Prepare any non-scalar elements to be passed along with the request.
$serverTlsPolicy = (new ServerTlsPolicy())
->setName($serverTlsPolicyName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $networkSecurityClient->createServerTlsPolicy(
$formattedParent,
$serverTlsPolicyId,
$serverTlsPolicy
);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ServerTlsPolicy $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 = NetworkSecurityClient::locationName('[PROJECT]', '[LOCATION]');
$serverTlsPolicyId = '[SERVER_TLS_POLICY_ID]';
$serverTlsPolicyName = '[NAME]';
create_server_tls_policy_sample($formattedParent, $serverTlsPolicyId, $serverTlsPolicyName);
}
deleteAuthorizationPolicy
Deletes a single AuthorizationPolicy.
Parameters | |
---|---|
Name | Description |
name |
string
Required. A name of the AuthorizationPolicy to delete. Must be in the
format |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
use Google\Rpc\Status;
/**
* @param string $formattedName A name of the AuthorizationPolicy to delete. Must be in the
* format `projects/{project}/locations/{location}/authorizationPolicies/*`. Please see
* {@see NetworkSecurityClient::authorizationPolicyName()} for help formatting this field.
*/
function delete_authorization_policy_sample(string $formattedName): void
{
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $networkSecurityClient->deleteAuthorizationPolicy($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 = NetworkSecurityClient::authorizationPolicyName(
'[PROJECT]',
'[LOCATION]',
'[AUTHORIZATION_POLICY]'
);
delete_authorization_policy_sample($formattedName);
}
deleteClientTlsPolicy
Deletes a single ClientTlsPolicy.
Parameters | |
---|---|
Name | Description |
name |
string
Required. A name of the ClientTlsPolicy to delete. Must be in
the format |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
use Google\Rpc\Status;
/**
* @param string $formattedName A name of the ClientTlsPolicy to delete. Must be in
* the format `projects/*/locations/{location}/clientTlsPolicies/*`. Please see
* {@see NetworkSecurityClient::clientTlsPolicyName()} for help formatting this field.
*/
function delete_client_tls_policy_sample(string $formattedName): void
{
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $networkSecurityClient->deleteClientTlsPolicy($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 = NetworkSecurityClient::clientTlsPolicyName(
'[PROJECT]',
'[LOCATION]',
'[CLIENT_TLS_POLICY]'
);
delete_client_tls_policy_sample($formattedName);
}
deleteServerTlsPolicy
Deletes a single ServerTlsPolicy.
Parameters | |
---|---|
Name | Description |
name |
string
Required. A name of the ServerTlsPolicy to delete. Must be in
the format |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
use Google\Rpc\Status;
/**
* @param string $formattedName A name of the ServerTlsPolicy to delete. Must be in
* the format `projects/*/locations/{location}/serverTlsPolicies/*`. Please see
* {@see NetworkSecurityClient::serverTlsPolicyName()} for help formatting this field.
*/
function delete_server_tls_policy_sample(string $formattedName): void
{
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $networkSecurityClient->deleteServerTlsPolicy($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 = NetworkSecurityClient::serverTlsPolicyName(
'[PROJECT]',
'[LOCATION]',
'[SERVER_TLS_POLICY]'
);
delete_server_tls_policy_sample($formattedName);
}
getAuthorizationPolicy
Gets details of a single AuthorizationPolicy.
Parameters | |
---|---|
Name | Description |
name |
string
Required. A name of the AuthorizationPolicy to get. Must be in the format
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\NetworkSecurity\V1beta1\AuthorizationPolicy |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkSecurity\V1beta1\AuthorizationPolicy;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
/**
* @param string $formattedName A name of the AuthorizationPolicy to get. Must be in the format
* `projects/{project}/locations/{location}/authorizationPolicies/*`. Please see
* {@see NetworkSecurityClient::authorizationPolicyName()} for help formatting this field.
*/
function get_authorization_policy_sample(string $formattedName): void
{
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Call the API and handle any network failures.
try {
/** @var AuthorizationPolicy $response */
$response = $networkSecurityClient->getAuthorizationPolicy($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 = NetworkSecurityClient::authorizationPolicyName(
'[PROJECT]',
'[LOCATION]',
'[AUTHORIZATION_POLICY]'
);
get_authorization_policy_sample($formattedName);
}
getClientTlsPolicy
Gets details of a single ClientTlsPolicy.
Parameters | |
---|---|
Name | Description |
name |
string
Required. A name of the ClientTlsPolicy to get. Must be in the format
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\NetworkSecurity\V1beta1\ClientTlsPolicy |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkSecurity\V1beta1\ClientTlsPolicy;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
/**
* @param string $formattedName A name of the ClientTlsPolicy to get. Must be in the format
* `projects/*/locations/{location}/clientTlsPolicies/*`. Please see
* {@see NetworkSecurityClient::clientTlsPolicyName()} for help formatting this field.
*/
function get_client_tls_policy_sample(string $formattedName): void
{
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Call the API and handle any network failures.
try {
/** @var ClientTlsPolicy $response */
$response = $networkSecurityClient->getClientTlsPolicy($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 = NetworkSecurityClient::clientTlsPolicyName(
'[PROJECT]',
'[LOCATION]',
'[CLIENT_TLS_POLICY]'
);
get_client_tls_policy_sample($formattedName);
}
getServerTlsPolicy
Gets details of a single ServerTlsPolicy.
Parameters | |
---|---|
Name | Description |
name |
string
Required. A name of the ServerTlsPolicy to get. Must be in the format
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\NetworkSecurity\V1beta1\ServerTlsPolicy |
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
use Google\Cloud\NetworkSecurity\V1beta1\ServerTlsPolicy;
/**
* @param string $formattedName A name of the ServerTlsPolicy to get. Must be in the format
* `projects/*/locations/{location}/serverTlsPolicies/*`. Please see
* {@see NetworkSecurityClient::serverTlsPolicyName()} for help formatting this field.
*/
function get_server_tls_policy_sample(string $formattedName): void
{
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Call the API and handle any network failures.
try {
/** @var ServerTlsPolicy $response */
$response = $networkSecurityClient->getServerTlsPolicy($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 = NetworkSecurityClient::serverTlsPolicyName(
'[PROJECT]',
'[LOCATION]',
'[SERVER_TLS_POLICY]'
);
get_server_tls_policy_sample($formattedName);
}
listAuthorizationPolicies
Lists AuthorizationPolicies in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The project and location from which the AuthorizationPolicies
should be listed, specified in the format
|
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. |
↳ 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\V1beta1\AuthorizationPolicy;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
/**
* @param string $formattedParent The project and location from which the AuthorizationPolicies
* should be listed, specified in the format
* `projects/{project}/locations/{location}`. Please see
* {@see NetworkSecurityClient::locationName()} for help formatting this field.
*/
function list_authorization_policies_sample(string $formattedParent): void
{
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $networkSecurityClient->listAuthorizationPolicies($formattedParent);
/** @var AuthorizationPolicy $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 = NetworkSecurityClient::locationName('[PROJECT]', '[LOCATION]');
list_authorization_policies_sample($formattedParent);
}
listClientTlsPolicies
Lists ClientTlsPolicies in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The project and location from which the ClientTlsPolicies should
be listed, specified in the format |
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. |
↳ 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\V1beta1\ClientTlsPolicy;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
/**
* @param string $formattedParent The project and location from which the ClientTlsPolicies should
* be listed, specified in the format `projects/*/locations/{location}`. Please see
* {@see NetworkSecurityClient::locationName()} for help formatting this field.
*/
function list_client_tls_policies_sample(string $formattedParent): void
{
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $networkSecurityClient->listClientTlsPolicies($formattedParent);
/** @var ClientTlsPolicy $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 = NetworkSecurityClient::locationName('[PROJECT]', '[LOCATION]');
list_client_tls_policies_sample($formattedParent);
}
listServerTlsPolicies
Lists ServerTlsPolicies in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
string
Required. The project and location from which the ServerTlsPolicies should
be listed, specified in the format |
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. |
↳ 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\V1beta1\NetworkSecurityClient;
use Google\Cloud\NetworkSecurity\V1beta1\ServerTlsPolicy;
/**
* @param string $formattedParent The project and location from which the ServerTlsPolicies should
* be listed, specified in the format `projects/*/locations/{location}`. Please see
* {@see NetworkSecurityClient::locationName()} for help formatting this field.
*/
function list_server_tls_policies_sample(string $formattedParent): void
{
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $networkSecurityClient->listServerTlsPolicies($formattedParent);
/** @var ServerTlsPolicy $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 = NetworkSecurityClient::locationName('[PROJECT]', '[LOCATION]');
list_server_tls_policies_sample($formattedParent);
}
updateAuthorizationPolicy
Updates the parameters of a single AuthorizationPolicy.
Parameters | |
---|---|
Name | Description |
authorizationPolicy |
Google\Cloud\NetworkSecurity\V1beta1\AuthorizationPolicy
Required. Updated AuthorizationPolicy resource. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
Optional. Field mask is used to specify the fields to be overwritten in the AuthorizationPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
↳ 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\V1beta1\AuthorizationPolicy;
use Google\Cloud\NetworkSecurity\V1beta1\AuthorizationPolicy\Action;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
use Google\Rpc\Status;
/**
* @param string $authorizationPolicyName Name of the AuthorizationPolicy resource. It matches pattern
* `projects/{project}/locations/{location}/authorizationPolicies/<authorization_policy>`.
* @param int $authorizationPolicyAction The action to take when a rule match is found. Possible values
* are "ALLOW" or "DENY".
*/
function update_authorization_policy_sample(
string $authorizationPolicyName,
int $authorizationPolicyAction
): void {
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Prepare any non-scalar elements to be passed along with the request.
$authorizationPolicy = (new AuthorizationPolicy())
->setName($authorizationPolicyName)
->setAction($authorizationPolicyAction);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $networkSecurityClient->updateAuthorizationPolicy($authorizationPolicy);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var AuthorizationPolicy $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
{
$authorizationPolicyName = '[NAME]';
$authorizationPolicyAction = Action::ACTION_UNSPECIFIED;
update_authorization_policy_sample($authorizationPolicyName, $authorizationPolicyAction);
}
updateClientTlsPolicy
Updates the parameters of a single ClientTlsPolicy.
Parameters | |
---|---|
Name | Description |
clientTlsPolicy |
Google\Cloud\NetworkSecurity\V1beta1\ClientTlsPolicy
Required. Updated ClientTlsPolicy resource. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
Optional. Field mask is used to specify the fields to be overwritten in the ClientTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
↳ 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\V1beta1\ClientTlsPolicy;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
use Google\Rpc\Status;
/**
* @param string $clientTlsPolicyName Name of the ClientTlsPolicy resource. It matches the pattern
* `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}`
*/
function update_client_tls_policy_sample(string $clientTlsPolicyName): void
{
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Prepare any non-scalar elements to be passed along with the request.
$clientTlsPolicy = (new ClientTlsPolicy())
->setName($clientTlsPolicyName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $networkSecurityClient->updateClientTlsPolicy($clientTlsPolicy);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ClientTlsPolicy $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
{
$clientTlsPolicyName = '[NAME]';
update_client_tls_policy_sample($clientTlsPolicyName);
}
updateServerTlsPolicy
Updates the parameters of a single ServerTlsPolicy.
Parameters | |
---|---|
Name | Description |
serverTlsPolicy |
Google\Cloud\NetworkSecurity\V1beta1\ServerTlsPolicy
Required. Updated ServerTlsPolicy resource. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
Optional. Field mask is used to specify the fields to be overwritten in the ServerTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. |
↳ 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\V1beta1\NetworkSecurityClient;
use Google\Cloud\NetworkSecurity\V1beta1\ServerTlsPolicy;
use Google\Rpc\Status;
/**
* @param string $serverTlsPolicyName Name of the ServerTlsPolicy resource. It matches the pattern
* `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`
*/
function update_server_tls_policy_sample(string $serverTlsPolicyName): void
{
// Create a client.
$networkSecurityClient = new NetworkSecurityClient();
// Prepare any non-scalar elements to be passed along with the request.
$serverTlsPolicy = (new ServerTlsPolicy())
->setName($serverTlsPolicyName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $networkSecurityClient->updateServerTlsPolicy($serverTlsPolicy);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ServerTlsPolicy $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
{
$serverTlsPolicyName = '[NAME]';
update_server_tls_policy_sample($serverTlsPolicyName);
}
getLocation
Gets information about a location.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
Resource name for the location. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Location\Location |
use Google\ApiCore\ApiException;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
/**
* 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.
$networkSecurityClient = new NetworkSecurityClient();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $networkSecurityClient->getLocation();
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
optionalArgs |
array
Optional. |
↳ name |
string
The resource that owns the locations collection, if applicable. |
↳ filter |
string
The standard list filter. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
/**
* 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.
$networkSecurityClient = new NetworkSecurityClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $networkSecurityClient->listLocations();
/** @var Location $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |
optionalArgs |
array
Optional. |
↳ options |
GetPolicyOptions
OPTIONAL: A |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
/**
* @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.
$networkSecurityClient = new NetworkSecurityClient();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $networkSecurityClient->getIamPolicy($resource);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
policy |
Google\Cloud\Iam\V1\Policy
REQUIRED: The complete policy to be applied to the |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
/**
* @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.
$networkSecurityClient = new NetworkSecurityClient();
// Prepare any non-scalar elements to be passed along with the request.
$policy = new Policy();
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $networkSecurityClient->setIamPolicy($resource, $policy);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
testIamPermissions
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters | |
---|---|
Name | Description |
resource |
string
REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
permissions |
string[]
The set of permissions to check for the |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\NetworkSecurity\V1beta1\NetworkSecurityClient;
/**
* @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.
$networkSecurityClient = new NetworkSecurityClient();
// Prepare any non-scalar elements to be passed along with the request.
$permissions = [$permissionsElement,];
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $networkSecurityClient->testIamPermissions($resource, $permissions);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
$permissionsElement = '[PERMISSIONS]';
test_iam_permissions_sample($resource, $permissionsElement);
}
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\ApiCore\LongRunning\OperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
static::authorizationPolicyName
Formats a string containing the fully-qualified path to represent a authorization_policy resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
authorizationPolicy |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted authorization_policy resource. |
static::clientTlsPolicyName
Formats a string containing the fully-qualified path to represent a client_tls_policy resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
clientTlsPolicy |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted client_tls_policy 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::serverTlsPolicyName
Formats a string containing the fully-qualified path to represent a server_tls_policy resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
serverTlsPolicy |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted server_tls_policy 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
- authorizationPolicy: projects/{project}/locations/{location}/authorizationPolicies/{authorization_policy}
- clientTlsPolicy: projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}
- location: projects/{project}/locations/{location}
- serverTlsPolicy: projects/{project}/locations/{location}/serverTlsPolicies/{server_tls_policy}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array |
An associative array from name component IDs to component values. |
Constants
SERVICE_NAME
Value: 'google.cloud.networksecurity.v1beta1.NetworkSecurity'
The name of the service.
SERVICE_ADDRESS
Value: 'networksecurity.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.