Package com.google.cloud.aiplatform.v1

Class ListNotebookRuntimesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.ListNotebookRuntimesRequest
All Implemented Interfaces:
ListNotebookRuntimesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ListNotebookRuntimesRequest extends com.google.protobuf.GeneratedMessage implements ListNotebookRuntimesRequestOrBuilder
 Request message for
 [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes].
Protobuf type google.cloud.aiplatform.v1.ListNotebookRuntimesRequest
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getParent

      public 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) = { ... }
      Specified by:
      getParent in interface ListNotebookRuntimesRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ListNotebookRuntimesRequestOrBuilder
      Returns:
      The bytes for parent.

    • getFilter

      public 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];
      Specified by:
      getFilter in interface ListNotebookRuntimesRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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];
      Specified by:
      getFilterBytes in interface ListNotebookRuntimesRequestOrBuilder
      Returns:
      The bytes for filter.

    • getPageSize

      public int getPageSize()
       Optional. The standard list page size.
      int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageSize in interface ListNotebookRuntimesRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public 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];
      Specified by:
      getPageToken in interface ListNotebookRuntimesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public 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];
      Specified by:
      getPageTokenBytes in interface ListNotebookRuntimesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • hasReadMask

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

    • getReadMask

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

    • getReadMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
       Optional. Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getReadMaskOrBuilder in interface ListNotebookRuntimesRequestOrBuilder

    • getOrderBy

      public 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];
      Specified by:
      getOrderBy in interface ListNotebookRuntimesRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public 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];
      Specified by:
      getOrderByBytes in interface ListNotebookRuntimesRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ListNotebookRuntimesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListNotebookRuntimesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListNotebookRuntimesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListNotebookRuntimesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListNotebookRuntimesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListNotebookRuntimesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListNotebookRuntimesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListNotebookRuntimesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListNotebookRuntimesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListNotebookRuntimesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListNotebookRuntimesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListNotebookRuntimesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ListNotebookRuntimesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ListNotebookRuntimesRequest.Builder newBuilder()

    • newBuilder

      public static ListNotebookRuntimesRequest.Builder newBuilder(ListNotebookRuntimesRequest prototype)

    • toBuilder

      public ListNotebookRuntimesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ListNotebookRuntimesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ListNotebookRuntimesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListNotebookRuntimesRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<ListNotebookRuntimesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ListNotebookRuntimesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder