sessions

Creates, updates, deletes, gets or lists a sessions resource.

Overview

Name	sessions
Type	Resource
Id	google.dataproc.sessions

Fields

Name	Datatype	Description
name	string	Required. The resource name of the session.
createTime	string	Output only. The time when the session was created.
creator	string	Output only. The email address of the user who created the session.
environmentConfig	object	Environment configuration for a workload.
jupyterSession	object	Jupyter configuration for an interactive session.
labels	object	Optional. The labels to associate with the 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.
runtimeConfig	object	Runtime configuration for a workload.
runtimeInfo	object	Runtime information about workload execution.
sessionTemplate	string	Optional. 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]The template must be in the same project and Dataproc region as the session.
sparkConnectSession	object	Spark connect configuration for an interactive session.
state	string	Output only. A state of the session.
stateHistory	array	Output only. Historical state information for the session.
stateMessage	string	Output only. Session state details, such as the failure description if the state is FAILED.
stateTime	string	Output only. The time when the session entered the current state.
user	string	Optional. The email address of the user who owns the session.
uuid	string	Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.

Methods

Name	Accessible by	Required Params	Description
projects_locations_sessions_get	SELECT	locationsId, projectsId, sessionsId	Gets the resource representation for an interactive session.
projects_locations_sessions_list	SELECT	locationsId, projectsId	Lists interactive sessions.
projects_locations_sessions_create	INSERT	locationsId, projectsId	Create an interactive session asynchronously.
projects_locations_sessions_delete	DELETE	locationsId, projectsId, sessionsId	Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.
projects_locations_sessions_terminate	EXEC	locationsId, projectsId, sessionsId	Terminates the interactive session.

SELECT examples

Lists interactive sessions.

SELECT
name,
createTime,
creator,
environmentConfig,
jupyterSession,
labels,
runtimeConfig,
runtimeInfo,
sessionTemplate,
sparkConnectSession,
state,
stateHistory,
stateMessage,
stateTime,
user,
uuid
FROM google.dataproc.sessions
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new sessions resource.

All Properties

/*+ create */
INSERT INTO google.dataproc.sessions (
locationsId,
projectsId,
name,
jupyterSession,
sparkConnectSession,
labels,
runtimeConfig,
environmentConfig,
user,
sessionTemplate
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ jupyterSession }}',
'{{ sparkConnectSession }}',
'{{ labels }}',
'{{ runtimeConfig }}',
'{{ environmentConfig }}',
'{{ user }}',
'{{ sessionTemplate }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: uuid
      value: string
    - name: createTime
      value: string
    - name: jupyterSession
      value:
        - name: kernel
          value: string
        - name: displayName
          value: string
    - name: sparkConnectSession
      value: []
    - name: runtimeInfo
      value:
        - name: endpoints
          value: object
        - name: outputUri
          value: string
        - name: diagnosticOutputUri
          value: string
        - name: approximateUsage
          value:
            - name: milliDcuSeconds
              value: string
            - name: shuffleStorageGbSeconds
              value: string
            - name: milliAcceleratorSeconds
              value: string
            - name: acceleratorType
              value: string
        - name: currentUsage
          value:
            - name: milliDcu
              value: string
            - name: shuffleStorageGb
              value: string
            - name: milliDcuPremium
              value: string
            - name: shuffleStorageGbPremium
              value: string
            - name: milliAccelerator
              value: string
            - name: acceleratorType
              value: string
            - name: snapshotTime
              value: string
    - name: state
      value: string
    - name: stateMessage
      value: string
    - name: stateTime
      value: string
    - name: creator
      value: string
    - name: labels
      value: object
    - name: runtimeConfig
      value:
        - name: version
          value: string
        - name: containerImage
          value: string
        - name: properties
          value: object
        - name: repositoryConfig
          value:
            - name: pypiRepositoryConfig
              value:
                - name: pypiRepository
                  value: string
        - name: autotuningConfig
          value:
            - name: scenarios
              value:
                - string
        - name: cohort
          value: string
    - name: environmentConfig
      value:
        - name: executionConfig
          value:
            - name: serviceAccount
              value: string
            - name: networkUri
              value: string
            - name: subnetworkUri
              value: string
            - name: networkTags
              value:
                - string
            - name: kmsKey
              value: string
            - name: idleTtl
              value: string
            - name: ttl
              value: string
            - name: stagingBucket
              value: string
        - name: peripheralsConfig
          value:
            - name: metastoreService
              value: string
            - name: sparkHistoryServerConfig
              value:
                - name: dataprocCluster
                  value: string
    - name: user
      value: string
    - name: stateHistory
      value:
        - - name: state
            value: string
          - name: stateMessage
            value: string
          - name: stateStartTime
            value: string
    - name: sessionTemplate
      value: string

DELETE example

Deletes the specified sessions resource.

/*+ delete */
DELETE FROM google.dataproc.sessions
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}'
AND sessionsId = '{{ sessionsId }}';