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. Sample code to get started:

$privateCatalogClient = new PrivateCatalogClient();
try {
    $resource = 'resource';
    // Iterate over pages of elements
    $pagedResponse = $privateCatalogClient->searchCatalogs($resource);
    foreach ($pagedResponse->iteratePages() as $page) {
        foreach ($page as $element) {
            // doSomethingWith($element);
        }
    }
    // Alternatively:
    // Iterate through all elements
    $pagedResponse = $privateCatalogClient->searchCatalogs($resource);
    foreach ($pagedResponse->iterateAllElements() as $element) {
        // doSomethingWith($element);
    }
} finally {
    $privateCatalogClient->close();
}

Namespace

Google \ Cloud \ PrivateCatalog \ V1beta1

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.

searchCatalogs

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

Parameters
Name Description
resource string

Required. The name of the resource context. It can be in following formats:

    • projects/{project}
    • folders/{folder}
    • organizations/{organization}
optionalArgs array

Optional.
↳ query string

The query to filter the catalogs. The supported queries are: * * Get a single catalog: name=catalogs/{catalog}
↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ 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.

Parameters
Name Description
resource string

Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
optionalArgs array

Optional.
↳ query string

The query to filter the products. The supported queries are: * * List products of all catalogs: empty * * List products under a catalog: parent=catalogs/{catalog} * * Get a product by name: name=catalogs/{catalog}/products/{product}
↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ 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.

Parameters
Name Description
resource string

Required. The name of the resource context. See SearchCatalogsRequest.resource for details.
query string

Required. 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}
optionalArgs array

Optional.
↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
↳ 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);
}

Constants

SERVICE_NAME

Value: 'google.cloud.privatecatalog.v1beta1.PrivateCatalog'

The name of the service.

SERVICE_ADDRESS

Value: 'cloudprivatecatalog.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.