Class ListNotebookRuntimesRequest (3.47.0)

public final class ListNotebookRuntimesRequest extends GeneratedMessageV3 implements ListNotebookRuntimesRequestOrBuilder

Request message for NotebookService.ListNotebookRuntimes.

Protobuf type google.cloud.aiplatform.v1.ListNotebookRuntimesRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

ORDER_BY_FIELD_NUMBER

public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

READ_MASK_FIELD_NUMBER

public static final int READ_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListNotebookRuntimesRequest getDefaultInstance()
Returns
Type Description
ListNotebookRuntimesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListNotebookRuntimesRequest.Builder newBuilder()
Returns
Type Description
ListNotebookRuntimesRequest.Builder

newBuilder(ListNotebookRuntimesRequest prototype)

public static ListNotebookRuntimesRequest.Builder newBuilder(ListNotebookRuntimesRequest prototype)
Parameter
Name Description
prototype ListNotebookRuntimesRequest
Returns
Type Description
ListNotebookRuntimesRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListNotebookRuntimesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListNotebookRuntimesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListNotebookRuntimesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookRuntimesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListNotebookRuntimesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListNotebookRuntimesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListNotebookRuntimesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookRuntimesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListNotebookRuntimesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListNotebookRuntimesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListNotebookRuntimesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookRuntimesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListNotebookRuntimesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListNotebookRuntimesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListNotebookRuntimesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookRuntimesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListNotebookRuntimesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListNotebookRuntimesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListNotebookRuntimesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookRuntimesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListNotebookRuntimesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListNotebookRuntimesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListNotebookRuntimesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListNotebookRuntimesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListNotebookRuntimesRequest> parser()
Returns
Type Description
Parser<ListNotebookRuntimesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListNotebookRuntimesRequest getDefaultInstanceForType()
Returns
Type Description
ListNotebookRuntimesRequest

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

    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

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

Returns
Type Description
String

The filter.

getFilterBytes()

public 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].

    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

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

Returns
Type Description
ByteString

The bytes for filter.

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];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public 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
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. The standard list page size.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.

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

Returns
Type Description
ByteString

The bytes for pageToken.

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) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public 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
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListNotebookRuntimesRequest> getParserForType()
Returns
Type Description
Parser<ListNotebookRuntimesRequest>
Overrides

getReadMask()

public FieldMask getReadMask()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMask

The readMask.

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMaskOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasReadMask()

public boolean hasReadMask()

Optional. Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the readMask field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListNotebookRuntimesRequest.Builder newBuilderForType()
Returns
Type Description
ListNotebookRuntimesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListNotebookRuntimesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListNotebookRuntimesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListNotebookRuntimesRequest.Builder toBuilder()
Returns
Type Description
ListNotebookRuntimesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException