Skip to main content

sessions

Overview

Namesessions
TypeResource
Idgoogle.dataproc.sessions

Fields

NameDatatypeDescription
namestringRequired. The resource name of the session.
environmentConfigobjectEnvironment configuration for a workload.
stateMessagestringOutput only. Session state details, such as a failure description if the state is FAILED.
sessionTemplatestringOptional. The session template used by the session.Only resource names including project ID and location are valid.Example: https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]Note that the template must be in the same project and Dataproc region.
stateHistoryarrayOutput only. Historical state information for the session.
userstringOptional. The email address of the user who owns the session.
statestringOutput only. A state of the session.
labelsobjectOptional. The labels to associate with this session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
createTimestringOutput only. The time when the session was created.
jupyterSessionobjectJupyter configuration for an interactive session.
runtimeConfigobjectRuntime configuration for a workload.
creatorstringOutput only. The email address of the user who created the session.
runtimeInfoobjectRuntime information about workload execution.
uuidstringOutput only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.
stateTimestringOutput only. The time when the session entered a current state.

Methods

NameAccessible byRequired ParamsDescription
projects_locations_sessions_getSELECTlocationsId, projectsId, sessionsIdGets the resource representation for an interactive session.
projects_locations_sessions_listSELECTlocationsId, projectsIdLists interactive sessions.
projects_locations_sessions_createINSERTlocationsId, projectsIdCreate an interactive session asynchronously.
projects_locations_sessions_deleteDELETElocationsId, projectsId, sessionsIdDeletes the interactive session resource. If the session is not in terminal state, it will be terminated and deleted afterwards.
_projects_locations_sessions_listEXEClocationsId, projectsIdLists interactive sessions.
projects_locations_sessions_inject_credentialsEXEClocationsId, projectsId, sessionsIdInject Credentials in the interactive session.
projects_locations_sessions_terminateEXEClocationsId, projectsId, sessionsIdTerminates the interactive session.