Reference documentation and code samples for the Google Cloud Dataplex V1 Client class Session.
Represents an active analyze session running for a user.
Generated from protobuf message google.cloud.dataplex.v1.Session
Namespace
Google \ Cloud \ Dataplex \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id}
Output only. The relative resource name of the content, of the form:
projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id}
Returns
Type
Description
string
setName
Output only. The relative resource name of the content, of the form:
projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class Session (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.Session)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.Session)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.Session)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.Session)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.Session)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.Session)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.Session)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.Session)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.Session)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.Session)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.Session)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.Session)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.Session)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.Session)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.Session)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.Session)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.Session)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.Session)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.Session)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.Session)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.Session)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.Session)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.Session)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.Session) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class Session.\n\nRepresents an active analyze session running for a user.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.Session`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. The relative resource name of the content, of the form:\nprojects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id}\n\n### setName\n\nOutput only. The relative resource name of the content, of the form:\nprojects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id}\n\n### getUserId\n\nOutput only. Email of user running the session.\n\n### setUserId\n\nOutput only. Email of user running the session.\n\n### getCreateTime\n\nOutput only. Session start time.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. Session start time.\n\n### getState\n\nOutput only. State of Session\n\n### setState\n\nOutput only. State of Session"]]