Google Cloud Discovery Engine V1beta Client - Class ServingConfigServiceClient (0.11.3)

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class ServingConfigServiceClient.

Service Description: Service for operations related to ServingConfig.

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 \ V1beta \ 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.

getServingConfig

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ServingConfigServiceClient::getServingConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\GetServingConfigRequest` 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\DiscoveryEngine\V1beta\ServingConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\ServingConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\GetServingConfigRequest;
use Google\Cloud\DiscoveryEngine\V1beta\ServingConfig;

/**
 * @param string $formattedName The resource name of the ServingConfig to get. Format:
 *                              `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
 *                              Please see {@see ServingConfigServiceClient::servingConfigName()} for help formatting this field.
 */
function get_serving_config_sample(string $formattedName): void
{
    // Create a client.
    $servingConfigServiceClient = new ServingConfigServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ServingConfig $response */
        $response = $servingConfigServiceClient->getServingConfig($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 = ServingConfigServiceClient::servingConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[SERVING_CONFIG]'
    );

    get_serving_config_sample($formattedName);
}

listServingConfigs

Lists all ServingConfigs linked to this dataStore.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ServingConfigServiceClient::listServingConfigsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\ListServingConfigsRequest` 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\DiscoveryEngine\V1beta\Client\ServingConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\ListServingConfigsRequest;
use Google\Cloud\DiscoveryEngine\V1beta\ServingConfig;

/**
 * @param string $formattedParent Full resource name of the parent resource. Format:
 *                                `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
 *                                Please see {@see ServingConfigServiceClient::dataStoreName()} for help formatting this field.
 */
function list_serving_configs_sample(string $formattedParent): void
{
    // Create a client.
    $servingConfigServiceClient = new ServingConfigServiceClient();

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

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

        /** @var ServingConfig $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 = ServingConfigServiceClient::dataStoreName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]'
    );

    list_serving_configs_sample($formattedParent);
}

updateServingConfig

Updates a ServingConfig.

Returns a NOT_FOUND error if the ServingConfig does not exist.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\ServingConfigServiceClient::updateServingConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\UpdateServingConfigRequest` 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\DiscoveryEngine\V1beta\ServingConfig`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\ServingConfigServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\ServingConfig;
use Google\Cloud\DiscoveryEngine\V1beta\SolutionType;
use Google\Cloud\DiscoveryEngine\V1beta\UpdateServingConfigRequest;

/**
 * @param string $servingConfigDisplayName  The human readable serving 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    $servingConfigSolutionType Immutable. Specifies the solution type that a serving config can
 *                                          be associated with.
 */
function update_serving_config_sample(
    string $servingConfigDisplayName,
    int $servingConfigSolutionType
): void {
    // Create a client.
    $servingConfigServiceClient = new ServingConfigServiceClient();

    // Prepare the request message.
    $servingConfig = (new ServingConfig())
        ->setDisplayName($servingConfigDisplayName)
        ->setSolutionType($servingConfigSolutionType);
    $request = (new UpdateServingConfigRequest())
        ->setServingConfig($servingConfig);

    // Call the API and handle any network failures.
    try {
        /** @var ServingConfig $response */
        $response = $servingConfigServiceClient->updateServingConfig($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
{
    $servingConfigDisplayName = '[DISPLAY_NAME]';
    $servingConfigSolutionType = SolutionType::SOLUTION_TYPE_UNSPECIFIED;

    update_serving_config_sample($servingConfigDisplayName, $servingConfigSolutionType);
}

getServingConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\GetServingConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listServingConfigsAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\ListServingConfigsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateServingConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\UpdateServingConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::dataStoreName

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

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

Returns
Type	Description
`string`	The formatted data_store resource.

static::engineName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`

Returns
Type	Description
`string`	The formatted engine resource.

static::projectLocationCollectionDataStoreName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`

Returns
Type	Description
`string`	The formatted project_location_collection_data_store resource.

static::projectLocationCollectionDataStoreServingConfigName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`servingConfig`	`string`

Returns
Type	Description
`string`	The formatted project_location_collection_data_store_serving_config resource.

static::projectLocationCollectionEngineServingConfigName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`engine`	`string`
`servingConfig`	`string`

Returns
Type	Description
`string`	The formatted project_location_collection_engine_serving_config resource.

static::projectLocationDataStoreName

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

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

Returns
Type	Description
`string`	The formatted project_location_data_store resource.

static::projectLocationDataStoreServingConfigName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`servingConfig`	`string`

Returns
Type	Description
`string`	The formatted project_location_data_store_serving_config resource.

static::servingConfigName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`servingConfig`	`string`

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

dataStore: projects/{project}/locations/{location}/dataStores/{data_store}
engine: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
projectLocationCollectionDataStore: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
projectLocationCollectionDataStoreServingConfig: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}
projectLocationCollectionEngineServingConfig: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}
projectLocationDataStore: projects/{project}/locations/{location}/dataStores/{data_store}
projectLocationDataStoreServingConfig: projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}
servingConfig: projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_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.