1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudRetail
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsCatalogsControls

ProjectsLocationsCatalogsControls

class ProjectsLocationsCatalogsControls extends Resource (View source)

The "controls" collection of methods.

Typical usage is:

 $retailService = new Google\Service\CloudRetail(...);
 $controls = $retailService->projects_locations_catalogs_controls;

Methods

GoogleCloudRetailV2Control
create(string $parent, GoogleCloudRetailV2Control $postBody, array $optParams = [])

Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned. (controls.create)

GoogleProtobufEmpty
delete(string $name, array $optParams = [])

Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. (controls.delete)

GoogleCloudRetailV2Control
get(string $name, array $optParams = [])

Gets a Control. (controls.get)

GoogleCloudRetailV2ListControlsResponse
listProjectsLocationsCatalogsControls(string $parent, array $optParams = [])

Lists all Controls by their parent Catalog.

GoogleCloudRetailV2Control
patch(string $name, GoogleCloudRetailV2Control $postBody, array $optParams = [])

Updates a Control. Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned. (controls.patch)

Details

at line 49
GoogleCloudRetailV2Control create(string $parent, GoogleCloudRetailV2Control $postBody, array $optParams = [])

Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned. (controls.create)

Parameters

string $parent

Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
GoogleCloudRetailV2Control $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudRetailV2Control

Exceptions

Exception

at line 66
GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. (controls.delete)

Parameters

string $name

Required. The resource name of the Control to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_ id}/controls/{control_id}
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 82
GoogleCloudRetailV2Control get(string $name, array $optParams = [])

Gets a Control. (controls.get)

Parameters

string $name

Required. The resource name of the Control to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_ id}/controls/{control_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudRetailV2Control

Exceptions

Exception

at line 107
GoogleCloudRetailV2ListControlsResponse listProjectsLocationsCatalogsControls(string $parent, array $optParams = [])

Lists all Controls by their parent Catalog.

(controls.listProjectsLocationsCatalogsControls)

Parameters

string $parent

Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudRetailV2ListControlsResponse

Exceptions

Exception

at line 129
GoogleCloudRetailV2Control patch(string $name, GoogleCloudRetailV2Control $postBody, array $optParams = [])

Updates a Control. Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned. (controls.patch)

Parameters

string $name

Immutable. Fully qualified name projects/locations/global/catalogs/controls
GoogleCloudRetailV2Control $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudRetailV2Control

Exceptions

Exception