Google Cloud Discovery Engine V1 Client - Class WidgetConfigServiceClient (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class WidgetConfigServiceClient.

Service Description: Service for managing WidgetConfig configuration.

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 \ DiscoveryEngine \ 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 Google\Auth\FetchAuthTokenInterface|Google\ApiCore\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\DiscoveryEngine\V1\WidgetConfigServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new WidgetConfigServiceClient(['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|Google\ApiCore\Transport\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|Psr\Log\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'.

getWidgetConfig

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\GetWidgetConfigRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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\DiscoveryEngine\V1\WidgetConfig
Example
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\WidgetConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1\GetWidgetConfigRequest;
use Google\Cloud\DiscoveryEngine\V1\WidgetConfig;

/**
 * @param string $formattedName Full WidgetConfig resource name. Format:
 *                              `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`
 *                              Please see {@see WidgetConfigServiceClient::widgetConfigName()} for help formatting this field.
 */
function get_widget_config_sample(string $formattedName): void
{
    // Create a client.
    $widgetConfigServiceClient = new WidgetConfigServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var WidgetConfig $response */
        $response = $widgetConfigServiceClient->getWidgetConfig($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 = WidgetConfigServiceClient::widgetConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[WIDGET_CONFIG]'
    );

    get_widget_config_sample($formattedName);
}

updateWidgetConfig

Update a WidgetConfig.

The async variant is WidgetConfigServiceClient::updateWidgetConfigAsync() .

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\UpdateWidgetConfigRequest

A request to house fields associated with the call.

callOptions array

Optional.

↳ retrySettings Google\ApiCore\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\DiscoveryEngine\V1\WidgetConfig
Example
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\WidgetConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1\SolutionType;
use Google\Cloud\DiscoveryEngine\V1\UpdateWidgetConfigRequest;
use Google\Cloud\DiscoveryEngine\V1\WidgetConfig;

/**
 * @param string $widgetConfigDisplayName  The human readable widget config display name. Used in Discovery
 *                                         UI.
 *
 *                                         This field must be a UTF-8 encoded string with a length limit of 128
 *                                         characters. Otherwise, an INVALID_ARGUMENT error is returned.
 * @param int    $widgetConfigSolutionType Immutable. Specifies the solution type that this WidgetConfig can
 *                                         be used for.
 */
function update_widget_config_sample(
    string $widgetConfigDisplayName,
    int $widgetConfigSolutionType
): void {
    // Create a client.
    $widgetConfigServiceClient = new WidgetConfigServiceClient();

    // Prepare the request message.
    $widgetConfig = (new WidgetConfig())
        ->setDisplayName($widgetConfigDisplayName)
        ->setSolutionType($widgetConfigSolutionType);
    $request = (new UpdateWidgetConfigRequest())
        ->setWidgetConfig($widgetConfig);

    // Call the API and handle any network failures.
    try {
        /** @var WidgetConfig $response */
        $response = $widgetConfigServiceClient->updateWidgetConfig($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
{
    $widgetConfigDisplayName = '[DISPLAY_NAME]';
    $widgetConfigSolutionType = SolutionType::SOLUTION_TYPE_UNSPECIFIED;

    update_widget_config_sample($widgetConfigDisplayName, $widgetConfigSolutionType);
}

getWidgetConfigAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\GetWidgetConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\WidgetConfig>

updateWidgetConfigAsync

Parameters
Name Description
request Google\Cloud\DiscoveryEngine\V1\UpdateWidgetConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\WidgetConfig>

static::projectLocationCollectionDataStoreWidgetConfigName

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

Parameters
Name Description
project string
location string
collection string
dataStore string
widgetConfig string
Returns
Type Description
string The formatted project_location_collection_data_store_widget_config resource.

static::projectLocationCollectionEngineWidgetConfigName

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

Parameters
Name Description
project string
location string
collection string
engine string
widgetConfig string
Returns
Type Description
string The formatted project_location_collection_engine_widget_config resource.

static::projectLocationDataStoreWidgetConfigName

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

Parameters
Name Description
project string
location string
dataStore string
widgetConfig string
Returns
Type Description
string The formatted project_location_data_store_widget_config resource.

static::widgetConfigName

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

Parameters
Name Description
project string
location string
dataStore string
widgetConfig string
Returns
Type Description
string The formatted widget_config 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

  • projectLocationCollectionDataStoreWidgetConfig: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/widgetConfigs/{widget_config}
  • projectLocationCollectionEngineWidgetConfig: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/widgetConfigs/{widget_config}
  • projectLocationDataStoreWidgetConfig: projects/{project}/locations/{location}/dataStores/{data_store}/widgetConfigs/{widget_config}
  • widgetConfig: projects/{project}/locations/{location}/dataStores/{data_store}/widgetConfigs/{widget_config}

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.