class ProjectsLocationsDocumentSchemas extends Resource (View source)

The "documentSchemas" collection of methods.

Typical usage is:

 $contentwarehouseService = new Google\Service\Contentwarehouse(...);
 $documentSchemas = $contentwarehouseService->projects_locations_documentSchemas;

Methods

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

Creates a document schema. (documentSchemas.create)

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

Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it. (documentSchemas.delete)

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

Gets a document schema. Returns NOT_FOUND if the document schema does not exist. (documentSchemas.get)

listProjectsLocationsDocumentSchemas(string $parent, array $optParams = [])

Lists document schemas.

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

Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values.

Details

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

Creates a document schema. (documentSchemas.create)

Parameters

string $parent

Required. The parent name.

GoogleCloudContentwarehouseV1DocumentSchema $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1DocumentSchema

Exceptions

Exception

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

Deletes a document schema. Returns NOT_FOUND if the document schema does not exist. Returns BAD_REQUEST if the document schema has documents depending on it. (documentSchemas.delete)

Parameters

string $name

Required. The name of the document schema to delete.

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

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

Gets a document schema. Returns NOT_FOUND if the document schema does not exist. (documentSchemas.get)

Parameters

string $name

Required. The name of the document schema to retrieve.

array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1DocumentSchema

Exceptions

Exception

GoogleCloudContentwarehouseV1ListDocumentSchemasResponse listProjectsLocationsDocumentSchemas(string $parent, array $optParams = [])

Lists document schemas.

(documentSchemas.listProjectsLocationsDocumentSchemas)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1ListDocumentSchemasResponse

Exceptions

Exception

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

Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the Document Schema is non-empty and does not equal the existing name. Supports only appending new properties, adding new ENUM possible values, and updating the EnumTypeOptions.validation_check_disabled flag for ENUM possible values.

Updating existing properties will result into INVALID_ARGUMENT. (documentSchemas.patch)

Parameters

string $name

Required. The name of the document schema to update. Format: projects/{project_number}/locations/{location}/documentSchemas/{docum ent_schema_id}.

GoogleCloudContentwarehouseV1UpdateDocumentSchemaRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudContentwarehouseV1DocumentSchema

Exceptions

Exception