com.google.cloud.aiplatform.v1beta1

Interface ListNotebookExecutionJobsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListNotebookExecutionJobsRequest, ListNotebookExecutionJobsRequest.Builder

public interface ListNotebookExecutionJobsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
String	getOrderBy() Optional.
com.google.protobuf.ByteString	getOrderByBytes() Optional.
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
NotebookExecutionJobView	getView() Optional.
int	getViewValue() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getFilter

String getFilter()

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

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

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

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for filter.

getPageSize

int getPageSize()

 Optional. The standard list page size.
 

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageSize.

getPageToken

String getPageToken()

 Optional. The standard list page token.
 Typically obtained via
 [ListNotebookExecutionJobs.next_page_token][] of the previous
 [NotebookService.ListNotebookExecutionJobs][google.cloud.aiplatform.v1beta1.NotebookService.ListNotebookExecutionJobs]
 call.
 

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 Optional. The standard list page token.
 Typically obtained via
 [ListNotebookExecutionJobs.next_page_token][] of the previous
 [NotebookService.ListNotebookExecutionJobs][google.cloud.aiplatform.v1beta1.NotebookService.ListNotebookExecutionJobs]
 call.
 

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for pageToken.

getOrderBy

String getOrderBy()

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

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

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

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for orderBy.

getViewValue

int getViewValue()

 Optional. The NotebookExecutionJob view. Defaults to BASIC.
 

.google.cloud.aiplatform.v1beta1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The enum numeric value on the wire for view.

getView

NotebookExecutionJobView getView()

 Optional. The NotebookExecutionJob view. Defaults to BASIC.
 

.google.cloud.aiplatform.v1beta1.NotebookExecutionJobView view = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The view.