Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1362267343.4 KB
projects

Create an interactive session asynchronously.

post/v1/{+parent}/sessions

Path parameters

parentstring required

Required. The parent resource where this session will be created.

Query parameters

requestIdstring

Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequests (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateSessionRequest)s with the same ID, the second request is ignored, and the first Session is created and stored in the backend.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

sessionIdstring

Required. The ID to use for the session, which becomes the final component of the session's resource name.This value must be 4-63 characters. Valid characters are /a-z-/.

Request body

creatorstring

Output only. The email address of the user who created 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.

uuidstring

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

userstring

Optional. The email address of the user who owns 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.

sparkConnectSessionSparkConnectConfig

Spark connect configuration for an interactive session.

namestring

Identifier. The resource name of the session.

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

Output only. A state of the session.

createTimestring google-datetime

Output only. The time when the session was created.

sessionTemplatestring

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.

Response

Successful response