Vertex AI API . projects . locations . notebookExecutionJobs

Instance Methods

close()

Close httplib2 connections.

generateAccessToken(name, body=None, x__xgafv=None)

Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd

reportEvent(name, body=None, x__xgafv=None)

Method Details

close()
Close httplib2 connections.
generateAccessToken(name, body=None, x__xgafv=None)
Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd

Args:
  name: string, Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for NotebookInternalService.GenerateAccessToken.
  "vmToken": "A String", # Required. The VM identity token (a JWT) for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for NotebookInternalService.GenerateToken.
  "accessToken": "A String", # Short-lived access token string which may be used to access Google APIs.
  "expiresIn": 42, # The time in seconds when the access token expires. Typically that's 3600.
  "scope": "A String", # Space-separated list of scopes contained in the returned token. https://cloud.google.com/docs/authentication/token-types#access-contents
  "tokenType": "A String", # Type of the returned access token (e.g. "Bearer"). It specifies how the token must be used. Bearer tokens may be used by any entity without proof of identity.
}
reportEvent(name, body=None, x__xgafv=None)

Args:
  name: string, Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` (required)
  body: object, The request body.
    The object takes the form of:

{ # LINT.IfChange(report_event_message_types) Request message for NotebookInternalService.ReportRuntimeEvent.
  "eventDetails": { # Optional. The details of the request for debug.
    "a_key": "A String",
  },
  "eventType": "A String", # Required. The type of the event.
  "vmToken": "A String", # Required. The VM identity token (a JWT) for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for NotebookInternalService.ReportRuntimeEvent.
  "idleShutdownMessage": "A String", # If the idle shutdown is blocked by CP, CP will send the block message. Otherwise, this field is not set.
}