Documentation

Google_Service_CloudPrivateCatalogProducer_Resource_CatalogsProducts extends Google_Service_Resource
in package

Application

The "products" collection of methods.

Typical usage is: $cloudprivatecatalogproducerService = new Google_Service_CloudPrivateCatalogProducer(...); $products = $cloudprivatecatalogproducerService->products;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
copy() : Google_Service_CloudPrivateCatalogProducer_GoogleLongrunningOperation: Copies a Product under another Catalog. (products.copy)
create() : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product: Creates a Product instance under a given Catalog. (products.create)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_CloudPrivateCatalogProducer_GoogleProtobufEmpty: Hard deletes a Product. (products.delete)
get() : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product: Returns the requested Product resource. (products.get)
listCatalogsProducts() : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse: Lists Product resources that the producer has access to, within the scope of the parent catalog. (products.listCatalogsProducts)
patch() : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product: Updates a specific Product resource. (products.patch)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

copy()

Copies a Product under another Catalog. (products.copy)


    public
                copy(string $name, Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1CopyProductRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudPrivateCatalogProducer_GoogleLongrunningOperation

Parameters

$name : string: The resource name of the current product that is copied from.
$postBody : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1CopyProductRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudPrivateCatalogProducer_GoogleLongrunningOperation —

create()

Creates a Product instance under a given Catalog. (products.create)


    public
                create(string $parent, Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product

Parameters

$parent : string: The catalog name of the new product's parent.
$postBody : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Hard deletes a Product. (products.delete)


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudPrivateCatalogProducer_GoogleProtobufEmpty

Parameters

$name : string: The resource name of the product.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudPrivateCatalogProducer_GoogleProtobufEmpty —

get()

Returns the requested Product resource. (products.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product

Parameters

$name : string: The resource name of the product.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product —

listCatalogsProducts()

Lists Product resources that the producer has access to, within the scope of the parent catalog. (products.listCatalogsProducts)


    public
                listCatalogsProducts(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse

Parameters

$parent : string: The resource name of the parent resource.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1ListProductsResponse —

patch()

Updates a specific Product resource. (products.patch)


    public
                patch(string $name, Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product

Parameters

$name : string: Required. The resource name of the product in the format `catalogs/{catalog_id}/products/a-z*[a-z0-9]'.

A unique identifier for the product under a catalog, which cannot be changed after the product is created. The final segment of the name must between 1 and 256 characters in length.
$postBody : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Product —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —