Connectors API . projects . locations . connections . entityTypes . entitieswithacls

Instance Methods

close()

Close httplib2 connections.

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

Lists entity rows with ACLs 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.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
list(parent, conditions=None, gsutilUri=None, pageSize=None, pageToken=None, sortBy=None, x__xgafv=None)
Lists entity rows with ACLs 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.
  gsutilUri: string, Format: gs://object_path
  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.ListEntitiesWithACLs
  "entitiesWithAcl": [ # List containing entity rows.
    { # EntityWithACL refers to a single row of an entity type with ACL information.
      "acl_info": { # AclInfo has a list of readers for a resource. This is defined as per the below docs https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.branches.documents#aclinfo # ACL information of the entity.
        "readers": [ # A list of readers for a resource.
          { # Readers is a list of principals that have read access to a resource.
            "principals": [ # A list of principals that have read access to a resource.
              { # Principal is a user or group that has access to a resource.
                "group_id": "A String", # The group that has access to a resource.
                "user_id": "A String", # The user that has access to a resource.
              },
            ],
          },
        ],
      },
      "id": "A String",
      "jsonData": "A String", # Entity data in JSON format.
    },
  ],
  "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.