public final class ListNotebookRuntimesRequest extends com.google.protobuf.GeneratedMessageV3 implements ListNotebookRuntimesRequestOrBuilder
Request message for [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1beta1.NotebookService.ListNotebookRuntimes].Protobuf type
google.cloud.aiplatform.v1beta1.ListNotebookRuntimesRequest| Modifier and Type | Class and Description |
|---|---|
static class |
ListNotebookRuntimesRequest.Builder
Request message for
[NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1beta1.NotebookService.ListNotebookRuntimes].
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
FILTER_FIELD_NUMBER |
static int |
ORDER_BY_FIELD_NUMBER |
static int |
PAGE_SIZE_FIELD_NUMBER |
static int |
PAGE_TOKEN_FIELD_NUMBER |
static int |
PARENT_FIELD_NUMBER |
static int |
READ_MASK_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static ListNotebookRuntimesRequest |
getDefaultInstance() |
ListNotebookRuntimesRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.Parser<ListNotebookRuntimesRequest> |
getParserForType() |
com.google.protobuf.FieldMask |
getReadMask()
Optional.
|
com.google.protobuf.FieldMaskOrBuilder |
getReadMaskOrBuilder()
Optional.
|
int |
getSerializedSize() |
int |
hashCode() |
boolean |
hasReadMask()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ListNotebookRuntimesRequest.Builder |
newBuilder() |
static ListNotebookRuntimesRequest.Builder |
newBuilder(ListNotebookRuntimesRequest prototype) |
ListNotebookRuntimesRequest.Builder |
newBuilderForType() |
protected ListNotebookRuntimesRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ListNotebookRuntimesRequest |
parseDelimitedFrom(InputStream input) |
static ListNotebookRuntimesRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListNotebookRuntimesRequest |
parseFrom(byte[] data) |
static ListNotebookRuntimesRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListNotebookRuntimesRequest |
parseFrom(ByteBuffer data) |
static ListNotebookRuntimesRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListNotebookRuntimesRequest |
parseFrom(com.google.protobuf.ByteString data) |
static ListNotebookRuntimesRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListNotebookRuntimesRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ListNotebookRuntimesRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ListNotebookRuntimesRequest |
parseFrom(InputStream input) |
static ListNotebookRuntimesRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ListNotebookRuntimesRequest> |
parser() |
ListNotebookRuntimesRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int PARENT_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
public static final int READ_MASK_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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) = { ... }
getParent in interface ListNotebookRuntimesRequestOrBuilderpublic 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) = { ... }
getParentBytes in interface ListNotebookRuntimesRequestOrBuilderpublic 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.v1beta1.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.v1beta1.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];getFilter in interface ListNotebookRuntimesRequestOrBuilderpublic 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.v1beta1.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.v1beta1.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];getFilterBytes in interface ListNotebookRuntimesRequestOrBuilderpublic int getPageSize()
Optional. The standard list page size.
int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];getPageSize in interface ListNotebookRuntimesRequestOrBuilderpublic String getPageToken()
Optional. The standard list page token. Typically obtained via [ListNotebookRuntimesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListNotebookRuntimesResponse.next_page_token] of the previous [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1beta1.NotebookService.ListNotebookRuntimes] call.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];getPageToken in interface ListNotebookRuntimesRequestOrBuilderpublic com.google.protobuf.ByteString getPageTokenBytes()
Optional. The standard list page token. Typically obtained via [ListNotebookRuntimesResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListNotebookRuntimesResponse.next_page_token] of the previous [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1beta1.NotebookService.ListNotebookRuntimes] call.
string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];getPageTokenBytes in interface ListNotebookRuntimesRequestOrBuilderpublic boolean hasReadMask()
Optional. Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
hasReadMask in interface ListNotebookRuntimesRequestOrBuilderpublic com.google.protobuf.FieldMask getReadMask()
Optional. Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
getReadMask in interface ListNotebookRuntimesRequestOrBuilderpublic com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
Optional. Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
getReadMaskOrBuilder in interface ListNotebookRuntimesRequestOrBuilderpublic 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];getOrderBy in interface ListNotebookRuntimesRequestOrBuilderpublic 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];getOrderByBytes in interface ListNotebookRuntimesRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ListNotebookRuntimesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListNotebookRuntimesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListNotebookRuntimesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListNotebookRuntimesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListNotebookRuntimesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListNotebookRuntimesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ListNotebookRuntimesRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static ListNotebookRuntimesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ListNotebookRuntimesRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ListNotebookRuntimesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ListNotebookRuntimesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ListNotebookRuntimesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ListNotebookRuntimesRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ListNotebookRuntimesRequest.Builder newBuilder()
public static ListNotebookRuntimesRequest.Builder newBuilder(ListNotebookRuntimesRequest prototype)
public ListNotebookRuntimesRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ListNotebookRuntimesRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ListNotebookRuntimesRequest getDefaultInstance()
public static com.google.protobuf.Parser<ListNotebookRuntimesRequest> parser()
public com.google.protobuf.Parser<ListNotebookRuntimesRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ListNotebookRuntimesRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.