class ProjectsLocationsConnectionsEntityTypesEntities extends Resource (View source)

The "entities" collection of methods.

Typical usage is:

 $connectorsService = new Google\Service\Connectors(...);
 $entities = $connectorsService->projects_locations_connections_entityTypes_entities;

Methods

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

Creates a new entity row of the specified entity type in the external system.

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

Deletes an existing entity row matching the entity type and entity id specified in the request. (entities.delete)

deleteEntitiesWithConditions(string $entityType, array $optParams = [])

Deletes entities based on conditions specified in the request and not on entity id. (entities.deleteEntitiesWithConditions)

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

Gets a single entity row matching the entity type and entity id specified in the request. (entities.get)

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

Lists entity rows of a particular entity type contained in the request. Note:

  1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.

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

Updates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are contained in the body of the request. All unspecified fields are left unchanged. The response message contains a Entity message object returned as a response by the external system. (entities.patch)

updateEntitiesWithConditions(string $entityType, Entity $postBody, array $optParams = [])

Updates entities based on conditions specified in the request and not on entity id. (entities.updateEntitiesWithConditions)

Details

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

Creates a new entity row of the specified entity type in the external system.

The field values for creating the row are contained in the body of the request. The response message contains a Entity message object returned as a response by the external system. (entities.create)

Parameters

string $parent

Required. Resource name of the Entity Type. Format: pro jects/{project}/locations/{location}/connections/{connection}/entityTypes/{ty pe}

Entity $postBody
array $optParams

Optional parameters.

Return Value

Entity

Exceptions

Exception

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

Deletes an existing entity row matching the entity type and entity id specified in the request. (entities.delete)

Parameters

string $name

Required. Resource name of the Entity Type. Format: proje cts/{project}/locations/{location}/connections/{connection}/entityTypes/{type }/entities/{id}

array $optParams

Optional parameters.

Return Value

ConnectorsEmpty

Exceptions

Exception

ConnectorsEmpty deleteEntitiesWithConditions(string $entityType, array $optParams = [])

Deletes entities based on conditions specified in the request and not on entity id. (entities.deleteEntitiesWithConditions)

Parameters

string $entityType

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/ {type}

array $optParams

Optional parameters.

Return Value

ConnectorsEmpty

Exceptions

Exception

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

Gets a single entity row matching the entity type and entity id specified in the request. (entities.get)

Parameters

string $name

Required. Resource name of the Entity Type. Format: proje cts/{project}/locations/{location}/connections/{connection}/entityTypes/{type }/entities/{id}

array $optParams

Optional parameters.

Return Value

Entity

Exceptions

Exception

ListEntitiesResponse listProjectsLocationsConnectionsEntityTypesEntities(string $parent, array $optParams = [])

Lists entity rows of a particular entity type contained in the request. Note:

  1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.

(entities.listProjectsLocationsConnectionsEntityTypesEntities)

Parameters

string $parent

Required. Resource name of the Entity Type. Format: pro jects/{project}/locations/{location}/connections/{connection}/entityTypes/{ty pe}

array $optParams

Optional parameters.

Return Value

ListEntitiesResponse

Exceptions

Exception

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

Updates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are contained in the body of the request. All unspecified fields are left unchanged. The response message contains a Entity message object returned as a response by the external system. (entities.patch)

Parameters

string $name

Output only. Resource name of the Entity. Format: project s/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/ entities/{id}

Entity $postBody
array $optParams

Optional parameters.

Return Value

Entity

Exceptions

Exception

UpdateEntitiesWithConditionsResponse updateEntitiesWithConditions(string $entityType, Entity $postBody, array $optParams = [])

Updates entities based on conditions specified in the request and not on entity id. (entities.updateEntitiesWithConditions)

Parameters

string $entityType

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/ {type}

Entity $postBody
array $optParams

Optional parameters.

Return Value

UpdateEntitiesWithConditionsResponse

Exceptions

Exception