Interface ListInstancesRequestOrBuilder (1.70.0)
Stay organized with collections
Save and categorize content based on your preferences.
public interface ListInstancesRequestOrBuilder extends MessageOrBuilder
Methods
getFilter()
public abstract String getFilter()
Optional. List filter.
string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
String |
The filter.
|
getFilterBytes()
public abstract ByteString getFilterBytes()
Optional. List filter.
string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
ByteString |
The bytes for filter.
|
getOrderBy()
public abstract String getOrderBy()
Optional. Sort results. Supported values are "name", "name desc" or ""
(unsorted).
string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
String |
The orderBy.
|
getOrderByBytes()
public abstract ByteString getOrderByBytes()
Optional. Sort results. Supported values are "name", "name desc" or ""
(unsorted).
string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
ByteString |
The bytes for orderBy.
|
getPageSize()
public abstract int getPageSize()
Optional. Maximum return size of the list call.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
int |
The pageSize.
|
getPageToken()
public abstract String getPageToken()
Optional. A previous returned page token that can be used to continue
listing from the last result.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
String |
The pageToken.
|
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()
Optional. A previous returned page token that can be used to continue
listing from the last result.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
ByteString |
The bytes for pageToken.
|
getParent()
public abstract String getParent()
Required. Format:
parent=projects/{project_id}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns |
Type |
Description |
String |
The parent.
|
getParentBytes()
public abstract ByteString getParentBytes()
Required. Format:
parent=projects/{project_id}/locations/{location}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns |
Type |
Description |
ByteString |
The bytes for parent.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-16 UTC."],[],[],null,["# Interface ListInstancesRequestOrBuilder (1.70.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.70.0 (latest)](/java/docs/reference/google-cloud-notebooks/latest/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.68.0](/java/docs/reference/google-cloud-notebooks/1.68.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.66.0](/java/docs/reference/google-cloud-notebooks/1.66.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.65.0](/java/docs/reference/google-cloud-notebooks/1.65.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.62.0](/java/docs/reference/google-cloud-notebooks/1.62.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.61.0](/java/docs/reference/google-cloud-notebooks/1.61.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.60.0](/java/docs/reference/google-cloud-notebooks/1.60.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.58.0](/java/docs/reference/google-cloud-notebooks/1.58.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.57.0](/java/docs/reference/google-cloud-notebooks/1.57.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.56.0](/java/docs/reference/google-cloud-notebooks/1.56.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.55.0](/java/docs/reference/google-cloud-notebooks/1.55.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.54.0](/java/docs/reference/google-cloud-notebooks/1.54.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.53.0](/java/docs/reference/google-cloud-notebooks/1.53.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.52.0](/java/docs/reference/google-cloud-notebooks/1.52.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.51.0](/java/docs/reference/google-cloud-notebooks/1.51.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.50.0](/java/docs/reference/google-cloud-notebooks/1.50.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.49.0](/java/docs/reference/google-cloud-notebooks/1.49.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.47.0](/java/docs/reference/google-cloud-notebooks/1.47.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.46.0](/java/docs/reference/google-cloud-notebooks/1.46.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.45.0](/java/docs/reference/google-cloud-notebooks/1.45.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.44.0](/java/docs/reference/google-cloud-notebooks/1.44.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.43.0](/java/docs/reference/google-cloud-notebooks/1.43.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.42.0](/java/docs/reference/google-cloud-notebooks/1.42.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.41.0](/java/docs/reference/google-cloud-notebooks/1.41.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.40.0](/java/docs/reference/google-cloud-notebooks/1.40.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.39.0](/java/docs/reference/google-cloud-notebooks/1.39.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.38.0](/java/docs/reference/google-cloud-notebooks/1.38.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.37.0](/java/docs/reference/google-cloud-notebooks/1.37.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.35.0](/java/docs/reference/google-cloud-notebooks/1.35.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.34.0](/java/docs/reference/google-cloud-notebooks/1.34.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.33.0](/java/docs/reference/google-cloud-notebooks/1.33.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.32.0](/java/docs/reference/google-cloud-notebooks/1.32.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.31.0](/java/docs/reference/google-cloud-notebooks/1.31.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.30.0](/java/docs/reference/google-cloud-notebooks/1.30.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.29.0](/java/docs/reference/google-cloud-notebooks/1.29.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.28.0](/java/docs/reference/google-cloud-notebooks/1.28.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.27.0](/java/docs/reference/google-cloud-notebooks/1.27.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.26.0](/java/docs/reference/google-cloud-notebooks/1.26.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.25.0](/java/docs/reference/google-cloud-notebooks/1.25.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.22.0](/java/docs/reference/google-cloud-notebooks/1.22.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.21.0](/java/docs/reference/google-cloud-notebooks/1.21.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.20.0](/java/docs/reference/google-cloud-notebooks/1.20.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.19.0](/java/docs/reference/google-cloud-notebooks/1.19.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.18.0](/java/docs/reference/google-cloud-notebooks/1.18.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.17.0](/java/docs/reference/google-cloud-notebooks/1.17.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.16.0](/java/docs/reference/google-cloud-notebooks/1.16.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.15.0](/java/docs/reference/google-cloud-notebooks/1.15.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.14.0](/java/docs/reference/google-cloud-notebooks/1.14.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.13.0](/java/docs/reference/google-cloud-notebooks/1.13.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.12.0](/java/docs/reference/google-cloud-notebooks/1.12.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.11.0](/java/docs/reference/google-cloud-notebooks/1.11.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.10.0](/java/docs/reference/google-cloud-notebooks/1.10.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.9.0](/java/docs/reference/google-cloud-notebooks/1.9.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.7.0](/java/docs/reference/google-cloud-notebooks/1.7.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.6.0](/java/docs/reference/google-cloud-notebooks/1.6.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.5.0](/java/docs/reference/google-cloud-notebooks/1.5.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.4.0](/java/docs/reference/google-cloud-notebooks/1.4.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.3.0](/java/docs/reference/google-cloud-notebooks/1.3.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.2.0](/java/docs/reference/google-cloud-notebooks/1.2.0/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.1.3](/java/docs/reference/google-cloud-notebooks/1.1.3/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [1.0.6](/java/docs/reference/google-cloud-notebooks/1.0.6/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder)\n- [0.6.2](/java/docs/reference/google-cloud-notebooks/0.6.2/com.google.cloud.notebooks.v2.ListInstancesRequestOrBuilder) \n\n public interface ListInstancesRequestOrBuilder extends MessageOrBuilder\n\nImplements\n----------\n\n[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)\n\nMethods\n-------\n\n### getFilter()\n\n public abstract String getFilter()\n\nOptional. List filter.\n\n`string filter = 5 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getFilterBytes()\n\n public abstract ByteString getFilterBytes()\n\nOptional. List filter.\n\n`string filter = 5 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getOrderBy()\n\n public abstract String getOrderBy()\n\nOptional. Sort results. Supported values are \"name\", \"name desc\" or \"\"\n(unsorted).\n\n`string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getOrderByBytes()\n\n public abstract ByteString getOrderByBytes()\n\nOptional. Sort results. Supported values are \"name\", \"name desc\" or \"\"\n(unsorted).\n\n`string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getPageSize()\n\n public abstract int getPageSize()\n\nOptional. Maximum return size of the list call.\n\n`int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getPageToken()\n\n public abstract String getPageToken()\n\nOptional. A previous returned page token that can be used to continue\nlisting from the last result.\n\n`string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getPageTokenBytes()\n\n public abstract ByteString getPageTokenBytes()\n\nOptional. A previous returned page token that can be used to continue\nlisting from the last result.\n\n`string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];`\n\n### getParent()\n\n public abstract String getParent()\n\nRequired. Format:\n`parent=projects/{project_id}/locations/{location}`\n\n`\nstring parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }\n`\n\n### getParentBytes()\n\n public abstract ByteString getParentBytes()\n\nRequired. Format:\n`parent=projects/{project_id}/locations/{location}`\n\n`\nstring parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }\n`"]]