Vertex AI API (aiplatform:v1)

2024-07-16

4 new methods

Additions

    Methods
  • aiplatform.projects.locations.notebookExecutionJobs.delete

      Parameter Order: name

      HTTP Method: DELETE

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}

      Parameters:

        name

          Location: path

          Type: string

          Description: Required. The name of the NotebookExecutionJob resource to be deleted.

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$

      Description: Deletes a NotebookExecutionJob.

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • aiplatform.projects.locations.notebookExecutionJobs.get

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}

      HTTP Method: GET

      Description: Gets a NotebookExecutionJob.

      Parameters:

        view

          Enum:

        • NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED
        • NOTEBOOK_EXECUTION_JOB_VIEW_BASIC
        • NOTEBOOK_EXECUTION_JOB_VIEW_FULL
        • Enum Descriptions:

        • When unspecified, the API defaults to the BASIC view.
        • Includes all fields except for direct notebook inputs.
        • Includes all fields.
        • Description: Optional. The NotebookExecutionJob view. Defaults to BASIC.

          Location: query

          Type: string

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$

          Required: Yes

          Location: path

          Description: Required. The name of the NotebookExecutionJob resource.

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1/{+name}

  • aiplatform.projects.locations.notebookExecutionJobs.create

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs

      Description: Creates a NotebookExecutionJob.

      Path: v1/{+parent}/notebookExecutionJobs

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: parent

      Parameters:

        parent

          Type: string

          Description: Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`

          Required: Yes

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+$

        notebookExecutionJobId

          Description: Optional. User specified ID for the NotebookExecutionJob.

          Type: string

          Location: query

  • aiplatform.projects.locations.notebookExecutionJobs.list

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs

      Parameter Order: parent

      Path: v1/{+parent}/notebookExecutionJobs

      Parameters:

        parent

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Type: string

          Description: Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`

          Location: path

        filter

          Description: Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`

          Type: string

          Location: query

        pageSize

          Description: Optional. The standard list page size.

          Location: query

          Format: int32

          Type: integer

        orderBy

          Location: query

          Description: Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.

          Type: string

        pageToken

          Location: query

          Description: Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.

          Type: string

        view

          Location: query

          Enum:

        • NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED
        • NOTEBOOK_EXECUTION_JOB_VIEW_BASIC
        • NOTEBOOK_EXECUTION_JOB_VIEW_FULL
        • Enum Descriptions:

        • When unspecified, the API defaults to the BASIC view.
        • Includes all fields except for direct notebook inputs.
        • Includes all fields.
        • Description: Optional. The NotebookExecutionJob view. Defaults to BASIC.

          Type: string

      HTTP Method: GET

      Description: Lists NotebookExecutionJobs in a Location.