Class ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource

The "entities" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource
Inherited Members
Namespace: Google.Apis.Connectors.v2
Assembly: Google.Apis.Connectors.v2.dll
Syntax
public class ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource

Constructors

EntitiesResource(IClientService)

Constructs a new resource.

Declaration
public EntitiesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Create(Entity, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.CreateRequest Create(Entity body, string parent)
Parameters
Type Name Description
Entity body

The body of the request.
string parent

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}
Returns
Type Description
ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.CreateRequest

Delete(string)

Deletes an existing entity row matching the entity type and entity id specified in the request.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
Returns
Type Description
ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.DeleteRequest

DeleteEntitiesWithConditions(string)

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

Declaration
public virtual ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.DeleteEntitiesWithConditionsRequest DeleteEntitiesWithConditions(string entityType)
Parameters
Type Name Description
string entityType

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}
Returns
Type Description
ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.DeleteEntitiesWithConditionsRequest

Get(string)

Gets a single entity row matching the entity type and entity id specified in the request.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
Returns
Type Description
ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.GetRequest

List(string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}
Returns
Type Description
ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.ListRequest

Patch(Entity, string)

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.

Declaration
public virtual ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.PatchRequest Patch(Entity body, string name)
Parameters
Type Name Description
Entity body

The body of the request.
string name

Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
Returns
Type Description
ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.PatchRequest

UpdateEntitiesWithConditions(Entity, string)

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

Declaration
public virtual ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.UpdateEntitiesWithConditionsRequest UpdateEntitiesWithConditions(Entity body, string entityType)
Parameters
Type Name Description
Entity body

The body of the request.
string entityType

Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}
Returns
Type Description
ProjectsResource.LocationsResource.ConnectionsResource.EntityTypesResource.EntitiesResource.UpdateEntitiesWithConditionsRequest