public final class ListNotebookRuntimesRequest extends GeneratedMessageV3 implements ListNotebookRuntimesRequestOrBuilder
Request message for
NotebookService.ListNotebookRuntimes.
Protobuf type google.cloud.aiplatform.v1.ListNotebookRuntimesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
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 |
|
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int READ_MASK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ListNotebookRuntimesRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ListNotebookRuntimesRequest.Builder newBuilder()
public static ListNotebookRuntimesRequest.Builder newBuilder(ListNotebookRuntimesRequest prototype)
public static ListNotebookRuntimesRequest parseDelimitedFrom(InputStream input)
public static ListNotebookRuntimesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListNotebookRuntimesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ListNotebookRuntimesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListNotebookRuntimesRequest parseFrom(ByteString data)
public static ListNotebookRuntimesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListNotebookRuntimesRequest parseFrom(CodedInputStream input)
public static ListNotebookRuntimesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListNotebookRuntimesRequest parseFrom(InputStream input)
public static ListNotebookRuntimesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListNotebookRuntimesRequest parseFrom(ByteBuffer data)
public static ListNotebookRuntimesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ListNotebookRuntimesRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public ListNotebookRuntimesRequest getDefaultInstanceForType()
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=HEALTHYruntimeState=RUNNINGruntimeUser="test@google.com"uiState=UI_RESOURCE_STATE_BEING_DELETEDnotebookRuntimeType=USER_DEFINED
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The filter.
|
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=HEALTHYruntimeState=RUNNINGruntimeUser="test@google.com"uiState=UI_RESOURCE_STATE_BEING_DELETEDnotebookRuntimeType=USER_DEFINED
string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
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:
string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The orderBy.
|
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:
string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for orderBy.
|
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.
|
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.
|
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.
|
public Parser<ListNotebookRuntimesRequest> getParserForType()
Overrides
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.
|
public FieldMaskOrBuilder getReadMaskOrBuilder()
Optional. Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListNotebookRuntimesRequest.Builder newBuilderForType()
protected ListNotebookRuntimesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ListNotebookRuntimesRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
