Google Cloud Private Catalog V1beta1 Client - Class PrivateCatalogClient (0.4.6)

Reference documentation and code samples for the Google Cloud Private Catalog V1beta1 Client class PrivateCatalogClient.

Service Description: PrivateCatalog allows catalog consumers to retrieve Catalog, Product and Version resources under a target resource context.

Catalog is computed based on the Associations linked to the target resource and its ancestors. Each association's google.cloud.privatecatalogproducer.v1beta.Catalog is transformed into a Catalog. If multiple associations have the same parent google.cloud.privatecatalogproducer.v1beta.Catalog, they are de-duplicated into one Catalog. Users must have cloudprivatecatalog.catalogTargets.get IAM permission on the resource context in order to access catalogs. Catalog contains the resource name and a subset of data of the original google.cloud.privatecatalogproducer.v1beta.Catalog.

Product is child resource of the catalog. A Product contains the resource name and a subset of the data of the original google.cloud.privatecatalogproducer.v1beta.Product.

Version is child resource of the product. A Version contains the resource name and a subset of the data of the original google.cloud.privatecatalogproducer.v1beta.Version.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Namespace

Google \ Cloud \ PrivateCatalog \ V1beta1 \ 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.
`↳ logger`	`false\|LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

searchCatalogs

Search Catalog resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

The async variant is PrivateCatalogClient::searchCatalogsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\PrivateCatalog\V1beta1\SearchCatalogsRequest` 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\PrivateCatalog\V1beta1\Catalog;
use Google\Cloud\PrivateCatalog\V1beta1\Client\PrivateCatalogClient;
use Google\Cloud\PrivateCatalog\V1beta1\SearchCatalogsRequest;

/**
 * @param string $resource The name of the resource context. It can be in following formats:
 *
 *                         * `projects/{project}`
 *                         * `folders/{folder}`
 *                         * `organizations/{organization}`
 */
function search_catalogs_sample(string $resource): void
{
    // Create a client.
    $privateCatalogClient = new PrivateCatalogClient();

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

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

        /** @var Catalog $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
{
    $resource = '[RESOURCE]';

    search_catalogs_sample($resource);
}

searchProducts

Search Product resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

The async variant is PrivateCatalogClient::searchProductsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\PrivateCatalog\V1beta1\SearchProductsRequest` 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\PrivateCatalog\V1beta1\Client\PrivateCatalogClient;
use Google\Cloud\PrivateCatalog\V1beta1\Product;
use Google\Cloud\PrivateCatalog\V1beta1\SearchProductsRequest;

/**
 * @param string $resource The name of the resource context. See [SearchCatalogsRequest.resource][google.cloud.privatecatalog.v1beta1.SearchCatalogsRequest.resource]
 *                         for details.
 */
function search_products_sample(string $resource): void
{
    // Create a client.
    $privateCatalogClient = new PrivateCatalogClient();

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

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

        /** @var Product $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
{
    $resource = '[RESOURCE]';

    search_products_sample($resource);
}

searchVersions

Search Version resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

The async variant is PrivateCatalogClient::searchVersionsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\PrivateCatalog\V1beta1\SearchVersionsRequest` 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\PrivateCatalog\V1beta1\Client\PrivateCatalogClient;
use Google\Cloud\PrivateCatalog\V1beta1\SearchVersionsRequest;
use Google\Cloud\PrivateCatalog\V1beta1\Version;

/**
 * @param string $resource The name of the resource context. See [SearchCatalogsRequest.resource][google.cloud.privatecatalog.v1beta1.SearchCatalogsRequest.resource]
 *                         for details.
 * @param string $query    The query to filter the versions.
 *
 *                         The supported queries are:
 *                         * List versions under a product:
 *                         `parent=catalogs/{catalog}/products/{product}`
 *                         * Get a version by name:
 *                         `name=catalogs/{catalog}/products/{product}/versions/{version}`
 */
function search_versions_sample(string $resource, string $query): void
{
    // Create a client.
    $privateCatalogClient = new PrivateCatalogClient();

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

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

        /** @var Version $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
{
    $resource = '[RESOURCE]';
    $query = '[QUERY]';

    search_versions_sample($resource, $query);
}

searchCatalogsAsync

Parameters
Name	Description
`request`	`Google\Cloud\PrivateCatalog\V1beta1\SearchCatalogsRequest`
`optionalArgs`	`array`

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

searchProductsAsync

Parameters
Name	Description
`request`	`Google\Cloud\PrivateCatalog\V1beta1\SearchProductsRequest`
`optionalArgs`	`array`

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

searchVersionsAsync

Parameters
Name	Description
`request`	`Google\Cloud\PrivateCatalog\V1beta1\SearchVersionsRequest`
`optionalArgs`	`array`

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