Class: Google::Cloud::AIPlatform::V1::ListNotebookExecutionJobsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/notebook_service.rb

Overview

Request message for [NotebookService.ListNotebookExecutionJobs]

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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"


503
504
505
506
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_service.rb', line 503

class ListNotebookExecutionJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns 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.



503
504
505
506
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_service.rb', line 503

class ListNotebookExecutionJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns Optional. The standard list page size.

Returns:

  • (::Integer) —

    Optional. The standard list page size.



503
504
505
506
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_service.rb', line 503

class ListNotebookExecutionJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

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

Returns:



503
504
505
506
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_service.rb', line 503

class ListNotebookExecutionJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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}



503
504
505
506
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_service.rb', line 503

class ListNotebookExecutionJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#view ⇒ ::Google::Cloud::AIPlatform::V1::NotebookExecutionJobView

Returns Optional. The NotebookExecutionJob view. Defaults to BASIC.

Returns:



503
504
505
506
 
# File 'proto_docs/google/cloud/aiplatform/v1/notebook_service.rb', line 503

class ListNotebookExecutionJobsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end