Method: projects.locations.lakes.environments.sessions.list

Stay organized with collections Save and categorize content based on your preferences.

Lists session resources in an environment.

HTTP request

GET https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*/lakes/*/environments/*}/sessions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the parent environment: projects/{project_number}/locations/{locationId}/lakes/{lakeId}/environment/{environmentId}.

Authorization requires the following IAM permission on the specified resource parent:

  • dataplex.environments.get

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 10 sessions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

Optional. Page token received from a previous sessions.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to sessions.list must match the call that provided the page token.

filter

string

Optional. Filter request. The following mode filter is supported to return only the sessions belonging to the requester when the mode is USER and return sessions of all the users when the mode is ADMIN. When no filter is sent default to USER mode. NOTE: When the mode is ADMIN, the requester should have dataplex.environments.listAllSessions permission to list all sessions, in absence of the permission, the request fails.

mode = ADMIN | USER

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

List sessions response.

JSON representation
{
  "sessions": [
    {
      object (Session)
    }
  ],
  "nextPageToken": string
}
Fields
sessions[]

object (Session)

Sessions under a given environment.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Session

Represents an active analyze session running for a user.

JSON representation
{
  "name": string,
  "userId": string,
  "createTime": string,
  "state": enum (State)
}
Fields
name

string

Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{locationId}/lakes/{lakeId}/environment/{environmentId}/sessions/{sessionId}

userId

string

Output only. Email of user running the session.

createTime

string (Timestamp format)

Output only. Session start time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

state

enum (State)