Google Cloud Dialogflow Cx V3 Client - Class SecuritySettingsServiceClient (0.5.0)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class SecuritySettingsServiceClient.

Service Description: Service for managing security settings for Dialogflow.

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 \ Dialogflow \ Cx \ V3 \ Client

Methods

__construct

Constructor.

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

createSecuritySettings

Create security settings in the specified location.

The async variant is SecuritySettingsServiceClient::createSecuritySettingsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\CreateSecuritySettingsRequest` 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\Dialogflow\Cx\V3\SecuritySettings`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\SecuritySettingsServiceClient;
use Google\Cloud\Dialogflow\Cx\V3\CreateSecuritySettingsRequest;
use Google\Cloud\Dialogflow\Cx\V3\SecuritySettings;

/**
 * @param string $formattedParent             The location to create an
 *                                            [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] for.
 *                                            Format: `projects/<ProjectID>/locations/<LocationID>`. Please see
 *                                            {@see SecuritySettingsServiceClient::locationName()} for help formatting this field.
 * @param string $securitySettingsDisplayName The human-readable name of the security settings, unique within
 *                                            the location.
 */
function create_security_settings_sample(
    string $formattedParent,
    string $securitySettingsDisplayName
): void {
    // Create a client.
    $securitySettingsServiceClient = new SecuritySettingsServiceClient();

    // Prepare the request message.
    $securitySettings = (new SecuritySettings())
        ->setDisplayName($securitySettingsDisplayName);
    $request = (new CreateSecuritySettingsRequest())
        ->setParent($formattedParent)
        ->setSecuritySettings($securitySettings);

    // Call the API and handle any network failures.
    try {
        /** @var SecuritySettings $response */
        $response = $securitySettingsServiceClient->createSecuritySettings($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 = SecuritySettingsServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $securitySettingsDisplayName = '[DISPLAY_NAME]';

    create_security_settings_sample($formattedParent, $securitySettingsDisplayName);
}

deleteSecuritySettings

Deletes the specified SecuritySettings.

The async variant is SecuritySettingsServiceClient::deleteSecuritySettingsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\DeleteSecuritySettingsRequest` 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\Dialogflow\Cx\V3\Client\SecuritySettingsServiceClient;
use Google\Cloud\Dialogflow\Cx\V3\DeleteSecuritySettingsRequest;

/**
 * @param string $formattedName The name of the
 *                              [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings] to
 *                              delete. Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/securitySettings/<SecuritySettingsID>`. Please see
 *                              {@see SecuritySettingsServiceClient::securitySettingsName()} for help formatting this field.
 */
function delete_security_settings_sample(string $formattedName): void
{
    // Create a client.
    $securitySettingsServiceClient = new SecuritySettingsServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $securitySettingsServiceClient->deleteSecuritySettings($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 = SecuritySettingsServiceClient::securitySettingsName(
        '[PROJECT]',
        '[LOCATION]',
        '[SECURITY_SETTINGS]'
    );

    delete_security_settings_sample($formattedName);
}

getSecuritySettings

Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.

The async variant is SecuritySettingsServiceClient::getSecuritySettingsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\GetSecuritySettingsRequest` 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\Dialogflow\Cx\V3\SecuritySettings`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\SecuritySettingsServiceClient;
use Google\Cloud\Dialogflow\Cx\V3\GetSecuritySettingsRequest;
use Google\Cloud\Dialogflow\Cx\V3\SecuritySettings;

/**
 * @param string $formattedName Resource name of the settings.
 *                              Format:
 *                              `projects/<ProjectID>/locations/<LocationID>/securitySettings/<securitysettingsID>`. Please see
 *                              {@see SecuritySettingsServiceClient::securitySettingsName()} for help formatting this field.
 */
function get_security_settings_sample(string $formattedName): void
{
    // Create a client.
    $securitySettingsServiceClient = new SecuritySettingsServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var SecuritySettings $response */
        $response = $securitySettingsServiceClient->getSecuritySettings($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 = SecuritySettingsServiceClient::securitySettingsName(
        '[PROJECT]',
        '[LOCATION]',
        '[SECURITY_SETTINGS]'
    );

    get_security_settings_sample($formattedName);
}

listSecuritySettings

Returns the list of all security settings in the specified location.

The async variant is SecuritySettingsServiceClient::listSecuritySettingsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ListSecuritySettingsRequest` 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\Dialogflow\Cx\V3\Client\SecuritySettingsServiceClient;
use Google\Cloud\Dialogflow\Cx\V3\ListSecuritySettingsRequest;
use Google\Cloud\Dialogflow\Cx\V3\SecuritySettings;

/**
 * @param string $formattedParent The location to list all security settings for.
 *                                Format: `projects/<ProjectID>/locations/<LocationID>`. Please see
 *                                {@see SecuritySettingsServiceClient::locationName()} for help formatting this field.
 */
function list_security_settings_sample(string $formattedParent): void
{
    // Create a client.
    $securitySettingsServiceClient = new SecuritySettingsServiceClient();

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

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

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

    list_security_settings_sample($formattedParent);
}

updateSecuritySettings

Updates the specified SecuritySettings.

The async variant is SecuritySettingsServiceClient::updateSecuritySettingsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\UpdateSecuritySettingsRequest` 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\Dialogflow\Cx\V3\SecuritySettings`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Dialogflow\Cx\V3\Client\SecuritySettingsServiceClient;
use Google\Cloud\Dialogflow\Cx\V3\SecuritySettings;
use Google\Cloud\Dialogflow\Cx\V3\UpdateSecuritySettingsRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $securitySettingsDisplayName The human-readable name of the security settings, unique within
 *                                            the location.
 */
function update_security_settings_sample(string $securitySettingsDisplayName): void
{
    // Create a client.
    $securitySettingsServiceClient = new SecuritySettingsServiceClient();

    // Prepare the request message.
    $securitySettings = (new SecuritySettings())
        ->setDisplayName($securitySettingsDisplayName);
    $updateMask = new FieldMask();
    $request = (new UpdateSecuritySettingsRequest())
        ->setSecuritySettings($securitySettings)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var SecuritySettings $response */
        $response = $securitySettingsServiceClient->updateSecuritySettings($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
{
    $securitySettingsDisplayName = '[DISPLAY_NAME]';

    update_security_settings_sample($securitySettingsDisplayName);
}

getLocation

Gets information about a location.

The async variant is SecuritySettingsServiceClient::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\Dialogflow\Cx\V3\Client\SecuritySettingsServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $securitySettingsServiceClient->getLocation($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

listLocations

Lists information about the supported locations for this service.

The async variant is SecuritySettingsServiceClient::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\Dialogflow\Cx\V3\Client\SecuritySettingsServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $securitySettingsServiceClient->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());
    }
}

createSecuritySettingsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\CreateSecuritySettingsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\Cx\V3\SecuritySettings>`

deleteSecuritySettingsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\DeleteSecuritySettingsRequest`
`optionalArgs`	`array`

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

getSecuritySettingsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\GetSecuritySettingsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\Cx\V3\SecuritySettings>`

listSecuritySettingsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\ListSecuritySettingsRequest`
`optionalArgs`	`array`

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

updateSecuritySettingsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Dialogflow\Cx\V3\UpdateSecuritySettingsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dialogflow\Cx\V3\SecuritySettings>`

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

static::deidentifyTemplateName

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

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`deidentifyTemplate`	`string`

Returns
Type	Description
`string`	The formatted deidentify_template resource.

static::inspectTemplateName

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

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`inspectTemplate`	`string`

Returns
Type	Description
`string`	The formatted inspect_template 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::organizationLocationDeidentifyTemplateName

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

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`deidentifyTemplate`	`string`

Returns
Type	Description
`string`	The formatted organization_location_deidentify_template resource.

static::organizationLocationInspectTemplateName

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

Parameters
Name	Description
`organization`	`string`
`location`	`string`
`inspectTemplate`	`string`

Returns
Type	Description
`string`	The formatted organization_location_inspect_template resource.

static::projectLocationDeidentifyTemplateName

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

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

Returns
Type	Description
`string`	The formatted project_location_deidentify_template resource.

static::projectLocationInspectTemplateName

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

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

Returns
Type	Description
`string`	The formatted project_location_inspect_template resource.

static::securitySettingsName

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

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

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

deidentifyTemplate: organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}
inspectTemplate: organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}
location: projects/{project}/locations/{location}
organizationLocationDeidentifyTemplate: organizations/{organization}/locations/{location}/deidentifyTemplates/{deidentify_template}
organizationLocationInspectTemplate: organizations/{organization}/locations/{location}/inspectTemplates/{inspect_template}
projectLocationDeidentifyTemplate: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}
projectLocationInspectTemplate: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
securitySettings: projects/{project}/locations/{location}/securitySettings/{security_settings}

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.