Package com.google.cloud.aiplatform.v1

Interface ListNotebookRuntimesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListNotebookRuntimesRequest, ListNotebookRuntimesRequest.Builder
@Generated public interface ListNotebookRuntimesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    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.
    com.google.protobuf.FieldMask
    getReadMask()
    Optional.
    com.google.protobuf.FieldMaskOrBuilder
    getReadMaskOrBuilder()
    Optional.
    boolean
    hasReadMask()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getParent

      String getParent()
       Required. The resource name of the Location from which to list the
 NotebookRuntimes.
 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
 NotebookRuntimes.
 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.

 * `notebookRuntime` supports = and !=. `notebookRuntime` represents the
 NotebookRuntime ID,
 i.e. the last segment of the NotebookRuntime's [resource name]
 [google.cloud.aiplatform.v1.NotebookRuntime.name].
 * `displayName` supports = and != and regex.
 * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate`
 represents the NotebookRuntimeTemplate ID,
 i.e. the last segment of the NotebookRuntimeTemplate's [resource name]
 [google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name].
 * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY,
 HEALTH_STATE_UNSPECIFIED].
 * `runtimeState` supports = and !=. runtimeState enum:
 [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED,
 STOPPED, BEING_UPGRADED, ERROR, INVALID].
 * `runtimeUser` supports = and !=.
 * API version is UI only: `uiState` supports = and !=. uiState enum:
 [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED,
 UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED,
 UI_RESOURCE_STATE_CREATION_FAILED].
 * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum:
 [USER_DEFINED, ONE_CLICK].
 * `machineType` supports = and !=.
 * `acceleratorType` supports = and !=.

 Some examples:

 * `notebookRuntime="notebookRuntime123"`
 * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
 * `notebookRuntimeTemplate="notebookRuntimeTemplate321"`
 * `healthState=HEALTHY`
 * `runtimeState=RUNNING`
 * `runtimeUser="test@google.com"`
 * `uiState=UI_RESOURCE_STATE_BEING_DELETED`
 * `notebookRuntimeType=USER_DEFINED`
 * `machineType=e2-standard-4`
 * `acceleratorType=NVIDIA_TESLA_T4`
      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.

 * `notebookRuntime` supports = and !=. `notebookRuntime` represents the
 NotebookRuntime ID,
 i.e. the last segment of the NotebookRuntime's [resource name]
 [google.cloud.aiplatform.v1.NotebookRuntime.name].
 * `displayName` supports = and != and regex.
 * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate`
 represents the NotebookRuntimeTemplate ID,
 i.e. the last segment of the NotebookRuntimeTemplate's [resource name]
 [google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name].
 * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY,
 HEALTH_STATE_UNSPECIFIED].
 * `runtimeState` supports = and !=. runtimeState enum:
 [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED,
 STOPPED, BEING_UPGRADED, ERROR, INVALID].
 * `runtimeUser` supports = and !=.
 * API version is UI only: `uiState` supports = and !=. uiState enum:
 [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED,
 UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED,
 UI_RESOURCE_STATE_CREATION_FAILED].
 * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum:
 [USER_DEFINED, ONE_CLICK].
 * `machineType` supports = and !=.
 * `acceleratorType` supports = and !=.

 Some examples:

 * `notebookRuntime="notebookRuntime123"`
 * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
 * `notebookRuntimeTemplate="notebookRuntimeTemplate321"`
 * `healthState=HEALTHY`
 * `runtimeState=RUNNING`
 * `runtimeUser="test@google.com"`
 * `uiState=UI_RESOURCE_STATE_BEING_DELETED`
 * `notebookRuntimeType=USER_DEFINED`
 * `machineType=e2-standard-4`
 * `acceleratorType=NVIDIA_TESLA_T4`
      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
 [ListNotebookRuntimesResponse.next_page_token][google.cloud.aiplatform.v1.ListNotebookRuntimesResponse.next_page_token]
 of the previous
 [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes]
 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
 [ListNotebookRuntimesResponse.next_page_token][google.cloud.aiplatform.v1.ListNotebookRuntimesResponse.next_page_token]
 of the previous
 [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes]
 call.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.

    • hasReadMask

      boolean hasReadMask()
       Optional. Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the readMask field is set.

    • getReadMask

      com.google.protobuf.FieldMask getReadMask()
       Optional. Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The readMask.

    • getReadMaskOrBuilder

      com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
       Optional. Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

    • 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 = 6 [(.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 = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for orderBy.