Documentation

Google_Service_CloudPrivateCatalogProducer_Resource_Catalogs extends Google_Service_Resource
in package

The "catalogs" collection of methods.

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

Table of Contents

$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.
create()  : Google_Service_CloudPrivateCatalogProducer_GoogleLongrunningOperation
Creates a new Catalog resource. (catalogs.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Catalog
Soft deletes an existing Catalog and all resources under it. The catalog can only be deleted if there is no associations under it or DeleteCatalogRequest.force is true. The delete operation can be recovered by the PrivateCatalogProducer.UndeleteCatalog method. (catalogs.delete)
get()  : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Catalog
Returns the requested Catalog resource. (catalogs.get)
getIamPolicy()  : Google_Service_CloudPrivateCatalogProducer_GoogleIamV1Policy
Gets IAM policy for the specified Catalog. (catalogs.getIamPolicy)
listCatalogs()  : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse
Lists Catalog resources that the producer has access to, within the scope of the parent resource. (catalogs.listCatalogs)
patch()  : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Catalog
Updates a specific Catalog resource. (catalogs.patch)
setIamPolicy()  : Google_Service_CloudPrivateCatalogProducer_GoogleIamV1Policy
Sets the IAM policy for the specified Catalog. (catalogs.setIamPolicy)
testIamPermissions()  : Google_Service_CloudPrivateCatalogProducer_GoogleIamV1TestIamPermissionsResponse
Tests the IAM permissions for the specified Catalog.
undelete()  : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Catalog
Undeletes a deleted Catalog and all resources under it. (catalogs.undelete)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

create()

Creates a new Catalog resource. (catalogs.create)

public create(Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Catalog $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudPrivateCatalogProducer_GoogleLongrunningOperation
Parameters
$postBody : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Catalog
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudPrivateCatalogProducer_GoogleLongrunningOperation —

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>
Tags
static
Return values
string —

$requestUrl

delete()

Soft deletes an existing Catalog and all resources under it. The catalog can only be deleted if there is no associations under it or DeleteCatalogRequest.force is true. The delete operation can be recovered by the PrivateCatalogProducer.UndeleteCatalog method. (catalogs.delete)

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

The resource name of the catalog.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool force Forces deletion of the Catalog and its Association resources. If the Catalog is still associated with other resources and force is not set to true, then the operation fails.

Return values
Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Catalog —

getIamPolicy()

Gets IAM policy for the specified Catalog. (catalogs.getIamPolicy)

public getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudPrivateCatalogProducer_GoogleIamV1Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int options.requestedPolicyVersion Optional. The policy format version to be returned.

Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.

Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.

Return values
Google_Service_CloudPrivateCatalogProducer_GoogleIamV1Policy —

listCatalogs()

Lists Catalog resources that the producer has access to, within the scope of the parent resource. (catalogs.listCatalogs)

public listCatalogs([array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken A pagination token returned from a previous call to ListCatalogs that indicates where this listing should continue from. This field is optional.

opt_param

int pageSize The maximum number of catalogs to return.

opt_param

string parent The resource name of the parent resource.

Return values
Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1ListCatalogsResponse —

patch()

Updates a specific Catalog resource. (catalogs.patch)

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

Output only. The resource name of the catalog, in the format `catalogs/{catalog_id}'.

A unique identifier for the catalog, which is generated by catalog service.

$postBody : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Catalog
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask Field mask that controls which fields of the catalog should be updated.

Return values
Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Catalog —

setIamPolicy()

Sets the IAM policy for the specified Catalog. (catalogs.setIamPolicy)

public setIamPolicy(string $resource, Google_Service_CloudPrivateCatalogProducer_GoogleIamV1SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudPrivateCatalogProducer_GoogleIamV1Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_CloudPrivateCatalogProducer_GoogleIamV1SetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudPrivateCatalogProducer_GoogleIamV1Policy —

testIamPermissions()

Tests the IAM permissions for the specified Catalog.

public testIamPermissions(string $resource, Google_Service_CloudPrivateCatalogProducer_GoogleIamV1TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudPrivateCatalogProducer_GoogleIamV1TestIamPermissionsResponse

(catalogs.testIamPermissions)

Parameters
$resource : string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_CloudPrivateCatalogProducer_GoogleIamV1TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudPrivateCatalogProducer_GoogleIamV1TestIamPermissionsResponse —

undelete()

Undeletes a deleted Catalog and all resources under it. (catalogs.undelete)

public undelete(string $name, Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1UndeleteCatalogRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Catalog
Parameters
$name : string

The resource name of the catalog.

$postBody : Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1UndeleteCatalogRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudPrivateCatalogProducer_GoogleCloudPrivatecatalogproducerV1beta1Catalog —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results