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

ProjectsLocationsCollectionsDataStoresSchemas

class ProjectsLocationsCollectionsDataStoresSchemas extends Resource (View source)

The "schemas" collection of methods.

Typical usage is:

 $discoveryengineService = new Google\Service\DiscoveryEngine(...);
 $schemas = $discoveryengineService->projects_locations_collections_dataStores_schemas;

Methods

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

Creates a Schema. (schemas.create)

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

Deletes a Schema. (schemas.delete)

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

Gets a Schema. (schemas.get)

GoogleCloudDiscoveryengineV1ListSchemasResponse
listProjectsLocationsCollectionsDataStoresSchemas(string $parent, array $optParams = [])

Gets a list of Schemas.

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

Updates a Schema. (schemas.patch)

Details

at line 50
GoogleLongrunningOperation create(string $parent, GoogleCloudDiscoveryengineV1Schema $postBody, array $optParams = [])

Creates a Schema. (schemas.create)

Parameters

string $parent

Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/d ataStores/{data_store}.
GoogleCloudDiscoveryengineV1Schema $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Deletes a Schema. (schemas.delete)

Parameters

string $name

Required. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/d ataStores/{data_store}/schemas/{schema}.
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Gets a Schema. (schemas.get)

Parameters

string $name

Required. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/d ataStores/{data_store}/schemas/{schema}.
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1Schema

Exceptions

Exception

at line 107
GoogleCloudDiscoveryengineV1ListSchemasResponse listProjectsLocationsCollectionsDataStoresSchemas(string $parent, array $optParams = [])

Gets a list of Schemas.

(schemas.listProjectsLocationsCollectionsDataStoresSchemas)

Parameters

string $parent

Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/d ataStores/{data_store}.
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1ListSchemasResponse

Exceptions

Exception

at line 128
GoogleLongrunningOperation patch(string $name, GoogleCloudDiscoveryengineV1Schema $postBody, array $optParams = [])

Updates a Schema. (schemas.patch)

Parameters

string $name

Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/d ataStores/{data_store}/schemas/{schema}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
GoogleCloudDiscoveryengineV1Schema $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception