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

ProjectsLocationsRuleSets

class ProjectsLocationsRuleSets extends Resource (View source)

The "ruleSets" collection of methods.

Typical usage is:

 $contentwarehouseService = new Google\Service\Contentwarehouse(...);
 $ruleSets = $contentwarehouseService->projects_locations_ruleSets;

Methods

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

Creates a ruleset. (ruleSets.create)

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

Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

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

Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.

GoogleCloudContentwarehouseV1ListRuleSetsResponse
listProjectsLocationsRuleSets(string $parent, array $optParams = [])

Lists rulesets. (ruleSets.listProjectsLocationsRuleSets)

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

Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name. (ruleSets.patch)

Details

at line 45
GoogleCloudContentwarehouseV1RuleSet create(string $parent, GoogleCloudContentwarehouseV1RuleSet $postBody, array $optParams = [])

Creates a ruleset. (ruleSets.create)

Parameters

string $parent

Required. The parent name. Format: projects/{project_number}/locations/{location}.
GoogleCloudContentwarehouseV1RuleSet $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1RuleSet

Exceptions

Exception

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

Deletes a ruleset. Returns NOT_FOUND if the document does not exist.

(ruleSets.delete)

Parameters

string $name

Required. The name of the rule set to delete. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 77
GoogleCloudContentwarehouseV1RuleSet get(string $name, array $optParams = [])

Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.

(ruleSets.get)

Parameters

string $name

Required. The name of the rule set to retrieve. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.
array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1RuleSet

Exceptions

Exception

at line 101
GoogleCloudContentwarehouseV1ListRuleSetsResponse listProjectsLocationsRuleSets(string $parent, array $optParams = [])

Lists rulesets. (ruleSets.listProjectsLocationsRuleSets)

Parameters

string $parent

Required. The parent, which owns this collection of document. Format: projects/{project_number}/locations/{location}.
array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1ListRuleSetsResponse

Exceptions

Exception

at line 118
GoogleCloudContentwarehouseV1RuleSet patch(string $name, GoogleCloudContentwarehouseV1UpdateRuleSetRequest $postBody, array $optParams = [])

Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset is non-empty and does not equal the existing name. (ruleSets.patch)

Parameters

string $name

Required. The name of the rule set to update. Format: projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.
GoogleCloudContentwarehouseV1UpdateRuleSetRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1RuleSet

Exceptions

Exception