GOgoogle
projects

GET /v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}

Changed on

Gets the resource representation for an interactive session.

Request

  • Base URL
    https://dataproc.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/dataproc
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/dataproc
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/dataproc.read-only
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/dataproc.read-only
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

projectsIdstring required
locationsIdstring required
sessionsIdstring required

Response

Successful response

createTimestring google-datetime

Output only. The time when the session was created.

creatorstring

Output only. The email address of the user who created the session.

labelsobject

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.

namestring

Identifier. The resource name of the session.

sessionTemplatestring

Optional. The session template used by the session.Resource names and short template IDs are valid. Examples: * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * [template_id]The template must be in the same project and Dataproc region as the session.

sparkConnectSessionSparkConnectConfig

Spark connect configuration for an interactive session.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'TERMINATING' | 'TERMINATED' | 'FAILED'

Output only. A state of the session.

stateMessagestring

Output only. Session state details, such as the failure description if the state is FAILED.

stateTimestring google-datetime

Output only. The time when the session entered the current state.

userstring

Optional. The email address of the user who owns the session.

uuidstring

Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.

Changes

  • 99b75ef6e002Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/dataproc.read-only was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/dataproc.read-only was removed from the endpoint's security scheme Oauth2c