Connectors API . projects . locations . connections . entityTypes . entities

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

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.

Args:
  parent: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} (required)
  body: object, The request body.
    The object takes the form of:

{ # 'Entity row'/ 'Entity' refers to a single row of an entity type.
  "fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
    "a_key": "",
  },
  "name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 'Entity row'/ 'Entity' refers to a single row of an entity type.
  "fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
    "a_key": "",
  },
  "name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
}

delete(name, x__xgafv=None)

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

Args:
  name: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

deleteEntitiesWithConditions(entityType, conditions=None, x__xgafv=None)

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

Args:
  entityType: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} (required)
  conditions: string, Required. Conditions to be used when deleting entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

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

Args:
  name: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 'Entity row'/ 'Entity' refers to a single row of an entity type.
  "fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
    "a_key": "",
  },
  "name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
}

list(parent, conditions=None, pageSize=None, pageToken=None, sortBy=None, x__xgafv=None)

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.

Args:
  parent: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} (required)
  conditions: string, Conditions to be used when listing entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported.
  pageSize: integer, Number of entity rows to return. Defaults page size = 25. Max page size = 200.
  pageToken: string, Page token value if available from a previous request.
  sortBy: string, List of 'sort_by' columns to use when returning the results. (repeated)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for EntityService.ListEntities
  "entities": [ # List containing entity rows.
    { # 'Entity row'/ 'Entity' refers to a single row of an entity type.
      "fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
        "a_key": "",
      },
      "name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
    },
  ],
  "nextPageToken": "A String", # Next page token if more records are available.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        

patch(name, body=None, x__xgafv=None)

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.

Args:
  name: string, Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} (required)
  body: object, The request body.
    The object takes the form of:

{ # 'Entity row'/ 'Entity' refers to a single row of an entity type.
  "fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
    "a_key": "",
  },
  "name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 'Entity row'/ 'Entity' refers to a single row of an entity type.
  "fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
    "a_key": "",
  },
  "name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
}

updateEntitiesWithConditions(entityType, body=None, conditions=None, x__xgafv=None)

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

Args:
  entityType: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} (required)
  body: object, The request body.
    The object takes the form of:

{ # 'Entity row'/ 'Entity' refers to a single row of an entity type.
  "fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
    "a_key": "",
  },
  "name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
}

  conditions: string, Required. Conditions to be used when updating entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for EntityService.UpdateEntitiesWithConditions
  "response": { # Response returned by the external system.
    "a_key": "", # Properties of the object.
  },
}