2023-08-22
▼ ▲ dataproc.projects.locations.sessionTemplates.delete
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/sessionTemplates/[^/]+$
Location: path
Required: Yes
Description: Required. The name of the session template resource to delete.
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates/{sessionTemplatesId}
Description: Deletes a session template.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
HTTP Method: DELETE
▼ ▲ dataproc.projects.locations.sessionTemplates.list
Parameters:
filter
Description: Optional. A filter for the session templates to return in the response. Filters are case sensitive and have the following syntax:field = value AND field = value ...
Location: query
Type: string
pageToken
Type: string
Location: query
Description: Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page.
parent
Description: Required. The parent, which owns this collection of session templates.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
pageSize
Format: int32
Description: Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.
Location: query
Type: integer
Description: Lists session templates.
Path: v1/{+parent}/sessionTemplates
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: parent
▼ ▲ dataproc.projects.locations.sessionTemplates.get
Path: v1/{+name}
Parameter Order: name
Description: Gets the resource representation for a session template.
HTTP Method: GET
Parameters:
name
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/sessionTemplates/[^/]+$
Type: string
Description: Required. The name of the session template to retrieve.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates/{sessionTemplatesId}
▼ ▲ dataproc.projects.locations.sessionTemplates.patch
Path: v1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/sessionTemplates/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The resource name of the session template.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates/{sessionTemplatesId}
Description: Updates the session template, synchronously.Disable check for update_mask, because all updates will be full replacements.
HTTP Method: PATCH
▼ ▲ dataproc.projects.locations.sessionTemplates.create
Parameter Order: parent
Description: Create an session template, synchronously.
Path: v1/{+parent}/sessionTemplates
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates
Parameters:
parent
Location: path
Required: Yes
Description: Required. The parent resource where this session template will be created.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
▼ ▲ dataproc.projects.locations.sessions.get
Path: v1/{+name}
Parameters:
name
Required: Yes
Location: path
Description: Required. The name of the session to retrieve.
Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+$
Type: string
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the resource representation for an interactive session.
▼ ▲ dataproc.projects.locations.sessions.terminate
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}:terminate
Parameter Order: name
Path: v1/{+name}:terminate
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+$
Description: Required. The name of the session resource to terminate.
Location: path
Type: string
Required: Yes
Description: Terminates the interactive session.
▼ ▲ dataproc.projects.locations.sessions.delete
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes the interactive session resource. If the session is not in terminal state, it will be terminated and deleted afterwards.
Parameters:
requestId
Location: query
Type: string
Description: Optional. A unique ID used to identify the request. If the service receives two DeleteSessionRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteSessionRequest)s with the same ID, the second request is ignored.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.
name
Description: Required. The name of the session resource to delete.
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}
HTTP Method: DELETE
Path: v1/{+name}
▼ ▲ dataproc.projects.locations.sessions.list
Parameter Order: parent
Description: Lists interactive sessions.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/sessions
Parameters:
parent
Description: Required. The parent, which owns this collection of sessions.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
pageSize
Location: query
Format: int32
Type: integer
Description: Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.
pageToken
Location: query
Description: Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page.
Type: string
filter
Location: query
Description: Optional. A filter for the sessions to return in the response.A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are session_id, session_uuid, state, and create_time.e.g. state = ACTIVE and create_time < "2023-01-01T00:00:00Z" filters for sessions in state ACTIVE that were created before 2023-01-01See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparisons.
Type: string
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions
▼ ▲ dataproc.projects.locations.sessions.create
Parameter Order: parent
Path: v1/{+parent}/sessions
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
sessionId
Description: 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-/.
Location: query
Type: string
requestId
Description: Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequest (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 is returned.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.
Type: string
Location: query
parent
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Description: Required. The parent resource where this session will be created.
Description: Create an interactive session asynchronously.
▼ ▲ dataproc.projects.locations.sessions.injectCredentials
Path: v1/{+session}:injectCredentials
HTTP Method: POST
Parameters:
session
Description: Required. The name of the session resource to inject credentials to.
Pattern: ^projects/[^/]+/locations/[^/]+/sessions/[^/]+$
Location: path
Type: string
Required: Yes
Description: Inject Credentials in the interactive session.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}:injectCredentials
Parameter Order: session