Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::ListNotebookExecutionJobsRequest (v0.56.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ListNotebookExecutionJobsRequest.

Request message for [NotebookService.ListNotebookExecutionJobs]

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) —

    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"

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) —

    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"
Returns
  • (::String) —

    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"

#order_by

def order_by() -> ::String
Returns
  • (::String) — 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.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. The standard list page size.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The standard list page size.
Returns
  • (::Integer) — Optional. The standard list page size.

#page_token

def page_token() -> ::String
Returns

#page_token=

def page_token=(value) -> ::String
Parameter
Returns

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: projects/{project}/locations/{location}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: projects/{project}/locations/{location}
Returns
  • (::String) — Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: projects/{project}/locations/{location}

#view

def view() -> ::Google::Cloud::AIPlatform::V1::NotebookExecutionJobView
Returns

#view=

def view=(value) -> ::Google::Cloud::AIPlatform::V1::NotebookExecutionJobView
Parameter
Returns