Deadline used while retrieving metadata for instances.
Instances whose metadata cannot be retrieved within this deadline will be
added to
[unreachable][google.spanner.admin.instance.v1.ListInstancesResponse.unreachable]
in
[ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
If non-empty, page_token should contain a
[next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token]
from a previous
[ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
[[["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-28 UTC."],[[["\u003cp\u003eThe latest version of the \u003ccode\u003eListInstancesRequest\u003c/code\u003e API is 5.0.0-beta05, with multiple previous versions also available, ranging down to version 3.5.0.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eListInstancesRequest\u003c/code\u003e is a class used to request a list of instances from the Google Cloud Spanner Instance Admin v1 API, inheriting from \u003ccode\u003eobject\u003c/code\u003e and implementing multiple interfaces such as \u003ccode\u003eIPageRequest\u003c/code\u003e and \u003ccode\u003eIMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis API allows for filtering the results by name, display name, or labels, as well as controlling the number of results returned per page and utilizing a page token for pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListInstancesRequest\u003c/code\u003e requires a parent project name to specify the scope of the request, and it also can set an \u003ccode\u003eInstanceDeadline\u003c/code\u003e to handle instances that cannot be reached.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eListInstancesRequest\u003c/code\u003e class can be instantiated with a default constructor, \u003ccode\u003eListInstancesRequest()\u003c/code\u003e, or via a copy constructor, \u003ccode\u003eListInstancesRequest(ListInstancesRequest other)\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Google Cloud Spanner Instance Administration v1 API - Class ListInstancesRequest (5.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [5.1.0 (latest)](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/latest/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [5.0.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/5.0.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [4.6.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/4.6.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [4.5.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/4.5.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [4.4.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/4.4.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [4.3.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/4.3.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [4.2.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/4.2.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [4.1.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/4.1.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [4.0.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/4.0.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [3.15.1](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/3.15.1/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [3.14.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/3.14.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [3.13.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/3.13.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [3.12.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/3.12.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [3.11.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/3.11.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [3.10.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/3.10.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/3.9.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/3.8.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/3.7.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/3.6.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/3.5.0/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest) \n\n public sealed class ListInstancesRequest : IPageRequest, IMessage\u003cListInstancesRequest\u003e, IEquatable\u003cListInstancesRequest\u003e, IDeepCloneable\u003cListInstancesRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Google Cloud Spanner Instance Administration v1 API class ListInstancesRequest.\n\nThe request for\n\\[ListInstances\\]\\[google.spanner.admin.instance.v1.InstanceAdmin.ListInstances\\]. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ListInstancesRequest \n\nImplements\n----------\n\n[IPageRequest](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.IPageRequest.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ListInstancesRequest](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/latest/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ListInstancesRequest](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/latest/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ListInstancesRequest](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/latest/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Spanner.Admin.Instance.V1](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/latest/Google.Cloud.Spanner.Admin.Instance.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Spanner.Admin.Instance.V1.dll\n\nConstructors\n------------\n\n### ListInstancesRequest()\n\n public ListInstancesRequest()\n\n### ListInstancesRequest(ListInstancesRequest)\n\n public ListInstancesRequest(ListInstancesRequest other)\n\nProperties\n----------\n\n### Filter\n\n public string Filter { get; set; }\n\nAn expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n- `name`\n- `display_name`\n- `labels.key` where key is the name of a label\n\nSome examples of using filters are:\n\n- `name:*` --\\\u003e The instance has a name.\n- `name:Howl` --\\\u003e The instance's name contains the string \"howl\".\n- `name:HOWL` --\\\u003e Equivalent to above.\n- `NAME:howl` --\\\u003e Equivalent to above.\n- `labels.env:*` --\\\u003e The instance has the label \"env\".\n- `labels.env:dev` --\\\u003e The instance has the label \"env\" and the value of the label contains the string \"dev\".\n- `name:howl labels.env:dev` --\\\u003e The instance's name contains \"howl\" and it has the label \"env\" with its value containing \"dev\".\n\n### InstanceDeadline\n\n public Timestamp InstanceDeadline { get; set; }\n\nDeadline used while retrieving metadata for instances.\nInstances whose metadata cannot be retrieved within this deadline will be\nadded to\n\\[unreachable\\]\\[google.spanner.admin.instance.v1.ListInstancesResponse.unreachable\\]\nin\n\\[ListInstancesResponse\\]\\[google.spanner.admin.instance.v1.ListInstancesResponse\\].\n\n### PageSize\n\n public int PageSize { get; set; }\n\nNumber of instances to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.\n\n### PageToken\n\n public string PageToken { get; set; }\n\nIf non-empty, `page_token` should contain a\n\\[next_page_token\\]\\[google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token\\]\nfrom a previous\n\\[ListInstancesResponse\\]\\[google.spanner.admin.instance.v1.ListInstancesResponse\\].\n\n### Parent\n\n public string Parent { get; set; }\n\nRequired. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.\n\n### ParentAsProjectName\n\n public ProjectName ParentAsProjectName { get; set; }\n\n[ProjectName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.ProjectName.html)-typed view over the [Parent](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Instance.V1/latest/Google.Cloud.Spanner.Admin.Instance.V1.ListInstancesRequest#Google_Cloud_Spanner_Admin_Instance_V1_ListInstancesRequest_Parent) resource name property."]]