Google Cloud Network Security V1 Client - Class DnsThreatDetectorServiceClient (1.3.0)

Reference documentation and code samples for the Google Cloud Network Security V1 Client class DnsThreatDetectorServiceClient.

Service Description: The Network Security API for DNS Threat Detectors.

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 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array\|Google\ApiCore\Options\ClientOptions` 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`	`FetchAuthTokenInterface\|CredentialsWrapper` This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly `use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\NetworkSecurity\V1\DnsThreatDetectorServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new DnsThreatDetectorServiceClient(['credentials' => $creds]);` 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 `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
`↳ logger`	`false\|LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag
`↳ universeDomain`	`string` The service domain for the client. Defaults to 'googleapis.com'.

createDnsThreatDetector

Creates a new DnsThreatDetector in a given project and location.

The async variant is DnsThreatDetectorServiceClient::createDnsThreatDetectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkSecurity\V1\CreateDnsThreatDetectorRequest` 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\DnsThreatDetector`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\NetworkSecurity\V1\Client\DnsThreatDetectorServiceClient;
use Google\Cloud\NetworkSecurity\V1\CreateDnsThreatDetectorRequest;
use Google\Cloud\NetworkSecurity\V1\DnsThreatDetector;
use Google\Cloud\NetworkSecurity\V1\DnsThreatDetector\Provider;

/**
 * @param string $formattedParent           The value for the parent of the DnsThreatDetector resource. Please see
 *                                          {@see DnsThreatDetectorServiceClient::locationName()} for help formatting this field.
 * @param int    $dnsThreatDetectorProvider The provider used for DNS threat analysis.
 */
function create_dns_threat_detector_sample(
    string $formattedParent,
    int $dnsThreatDetectorProvider
): void {
    // Create a client.
    $dnsThreatDetectorServiceClient = new DnsThreatDetectorServiceClient();

    // Prepare the request message.
    $dnsThreatDetector = (new DnsThreatDetector())
        ->setProvider($dnsThreatDetectorProvider);
    $request = (new CreateDnsThreatDetectorRequest())
        ->setParent($formattedParent)
        ->setDnsThreatDetector($dnsThreatDetector);

    // Call the API and handle any network failures.
    try {
        /** @var DnsThreatDetector $response */
        $response = $dnsThreatDetectorServiceClient->createDnsThreatDetector($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
{
    $formattedParent = DnsThreatDetectorServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $dnsThreatDetectorProvider = Provider::PROVIDER_UNSPECIFIED;

    create_dns_threat_detector_sample($formattedParent, $dnsThreatDetectorProvider);
}

deleteDnsThreatDetector

Deletes a single DnsThreatDetector.

The async variant is DnsThreatDetectorServiceClient::deleteDnsThreatDetectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkSecurity\V1\DeleteDnsThreatDetectorRequest` 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.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\NetworkSecurity\V1\Client\DnsThreatDetectorServiceClient;
use Google\Cloud\NetworkSecurity\V1\DeleteDnsThreatDetectorRequest;

/**
 * @param string $formattedName Name of the DnsThreatDetector resource. Please see
 *                              {@see DnsThreatDetectorServiceClient::dnsThreatDetectorName()} for help formatting this field.
 */
function delete_dns_threat_detector_sample(string $formattedName): void
{
    // Create a client.
    $dnsThreatDetectorServiceClient = new DnsThreatDetectorServiceClient();

    // Prepare the request message.
    $request = (new DeleteDnsThreatDetectorRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $dnsThreatDetectorServiceClient->deleteDnsThreatDetector($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = DnsThreatDetectorServiceClient::dnsThreatDetectorName(
        '[PROJECT]',
        '[LOCATION]',
        '[DNS_THREAT_DETECTOR]'
    );

    delete_dns_threat_detector_sample($formattedName);
}

getDnsThreatDetector

Gets the details of a single DnsThreatDetector.

The async variant is DnsThreatDetectorServiceClient::getDnsThreatDetectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkSecurity\V1\GetDnsThreatDetectorRequest` 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\DnsThreatDetector`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\NetworkSecurity\V1\Client\DnsThreatDetectorServiceClient;
use Google\Cloud\NetworkSecurity\V1\DnsThreatDetector;
use Google\Cloud\NetworkSecurity\V1\GetDnsThreatDetectorRequest;

/**
 * @param string $formattedName Name of the DnsThreatDetector resource. Please see
 *                              {@see DnsThreatDetectorServiceClient::dnsThreatDetectorName()} for help formatting this field.
 */
function get_dns_threat_detector_sample(string $formattedName): void
{
    // Create a client.
    $dnsThreatDetectorServiceClient = new DnsThreatDetectorServiceClient();

    // Prepare the request message.
    $request = (new GetDnsThreatDetectorRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var DnsThreatDetector $response */
        $response = $dnsThreatDetectorServiceClient->getDnsThreatDetector($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 = DnsThreatDetectorServiceClient::dnsThreatDetectorName(
        '[PROJECT]',
        '[LOCATION]',
        '[DNS_THREAT_DETECTOR]'
    );

    get_dns_threat_detector_sample($formattedName);
}

listDnsThreatDetectors

Lists DnsThreatDetectors in a given project and location.

The async variant is DnsThreatDetectorServiceClient::listDnsThreatDetectorsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkSecurity\V1\ListDnsThreatDetectorsRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\NetworkSecurity\V1\Client\DnsThreatDetectorServiceClient;
use Google\Cloud\NetworkSecurity\V1\DnsThreatDetector;
use Google\Cloud\NetworkSecurity\V1\ListDnsThreatDetectorsRequest;

/**
 * @param string $formattedParent The parent value for `ListDnsThreatDetectorsRequest`. Please see
 *                                {@see DnsThreatDetectorServiceClient::locationName()} for help formatting this field.
 */
function list_dns_threat_detectors_sample(string $formattedParent): void
{
    // Create a client.
    $dnsThreatDetectorServiceClient = new DnsThreatDetectorServiceClient();

    // Prepare the request message.
    $request = (new ListDnsThreatDetectorsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $dnsThreatDetectorServiceClient->listDnsThreatDetectors($request);

        /** @var DnsThreatDetector $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 = DnsThreatDetectorServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_dns_threat_detectors_sample($formattedParent);
}

updateDnsThreatDetector

Updates a single DnsThreatDetector.

The async variant is DnsThreatDetectorServiceClient::updateDnsThreatDetectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\NetworkSecurity\V1\UpdateDnsThreatDetectorRequest` 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\DnsThreatDetector`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\NetworkSecurity\V1\Client\DnsThreatDetectorServiceClient;
use Google\Cloud\NetworkSecurity\V1\DnsThreatDetector;
use Google\Cloud\NetworkSecurity\V1\DnsThreatDetector\Provider;
use Google\Cloud\NetworkSecurity\V1\UpdateDnsThreatDetectorRequest;

/**
 * @param int $dnsThreatDetectorProvider The provider used for DNS threat analysis.
 */
function update_dns_threat_detector_sample(int $dnsThreatDetectorProvider): void
{
    // Create a client.
    $dnsThreatDetectorServiceClient = new DnsThreatDetectorServiceClient();

    // Prepare the request message.
    $dnsThreatDetector = (new DnsThreatDetector())
        ->setProvider($dnsThreatDetectorProvider);
    $request = (new UpdateDnsThreatDetectorRequest())
        ->setDnsThreatDetector($dnsThreatDetector);

    // Call the API and handle any network failures.
    try {
        /** @var DnsThreatDetector $response */
        $response = $dnsThreatDetectorServiceClient->updateDnsThreatDetector($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
{
    $dnsThreatDetectorProvider = Provider::PROVIDER_UNSPECIFIED;

    update_dns_threat_detector_sample($dnsThreatDetectorProvider);
}

getLocation

Gets information about a location.

The async variant is DnsThreatDetectorServiceClient::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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkSecurity\V1\Client\DnsThreatDetectorServiceClient;

/**
 * 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.
    $dnsThreatDetectorServiceClient = new DnsThreatDetectorServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $dnsThreatDetectorServiceClient->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.

This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field:

Global locations: If name is empty, the method lists the public locations available to all projects. * Project-specific locations: If name follows the format projects/{project}, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project.

For gRPC and client library implementations, the resource name is passed as the name field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

The async variant is DnsThreatDetectorServiceClient::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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkSecurity\V1\Client\DnsThreatDetectorServiceClient;

/**
 * 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.
    $dnsThreatDetectorServiceClient = new DnsThreatDetectorServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $dnsThreatDetectorServiceClient->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 DnsThreatDetectorServiceClient::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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\NetworkSecurity\V1\Client\DnsThreatDetectorServiceClient;

/**
 * @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.
    $dnsThreatDetectorServiceClient = new DnsThreatDetectorServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $dnsThreatDetectorServiceClient->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 DnsThreatDetectorServiceClient::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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\NetworkSecurity\V1\Client\DnsThreatDetectorServiceClient;

/**
 * @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.
    $dnsThreatDetectorServiceClient = new DnsThreatDetectorServiceClient();

    // 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 = $dnsThreatDetectorServiceClient->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 DnsThreatDetectorServiceClient::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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\NetworkSecurity\V1\Client\DnsThreatDetectorServiceClient;

/**
 * @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.
    $dnsThreatDetectorServiceClient = new DnsThreatDetectorServiceClient();

    // 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 = $dnsThreatDetectorServiceClient->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);
}

createDnsThreatDetectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkSecurity\V1\CreateDnsThreatDetectorRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\NetworkSecurity\V1\DnsThreatDetector>`

deleteDnsThreatDetectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkSecurity\V1\DeleteDnsThreatDetectorRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<void>`

getDnsThreatDetectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkSecurity\V1\GetDnsThreatDetectorRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\NetworkSecurity\V1\DnsThreatDetector>`

listDnsThreatDetectorsAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkSecurity\V1\ListDnsThreatDetectorsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

updateDnsThreatDetectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\NetworkSecurity\V1\UpdateDnsThreatDetectorRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\NetworkSecurity\V1\DnsThreatDetector>`

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

static::dnsThreatDetectorName

Formats a string containing the fully-qualified path to represent a dns_threat_detector resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dnsThreatDetector`	`string`

Returns
Type	Description
`string`	The formatted dns_threat_detector resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::networkName

Formats a string containing the fully-qualified path to represent a network resource.

Parameters
Name	Description
`project`	`string`
`network`	`string`

Returns
Type	Description
`string`	The formatted network 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

dnsThreatDetector: projects/{project}/locations/{location}/dnsThreatDetectors/{dns_threat_detector}
location: projects/{project}/locations/{location}
network: projects/{project}/global/networks/{network}

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.

Google Cloud Network Security V1 Client - Class DnsThreatDetectorServiceClient (1.3.0) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

createDnsThreatDetector

deleteDnsThreatDetector

getDnsThreatDetector

listDnsThreatDetectors

updateDnsThreatDetector

getLocation

listLocations

getIamPolicy

setIamPolicy

testIamPermissions

createDnsThreatDetectorAsync

deleteDnsThreatDetectorAsync

getDnsThreatDetectorAsync

listDnsThreatDetectorsAsync

updateDnsThreatDetectorAsync

getLocationAsync

listLocationsAsync

getIamPolicyAsync

setIamPolicyAsync

testIamPermissionsAsync

static::dnsThreatDetectorName

static::locationName

static::networkName

static::parseName

Google Cloud Network Security V1 Client - Class DnsThreatDetectorServiceClient (1.3.0)