Google Cloud Spanner Instance Administration v1 API - Class ListInstancesRequest (5.5.0)
Stay organized with collections
Save and categorize content based on your preferences.
public sealed class ListInstancesRequest : IPageRequest, IMessage<ListInstancesRequest>, IEquatable<ListInstancesRequest>, IDeepCloneable<ListInstancesRequest>, IBufferMessage, IMessageReference documentation and code samples for the Google Cloud Spanner Instance Administration v1 API class ListInstancesRequest.
The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
Implements
IPageRequest, IMessage ListInstancesRequest, IEquatable ListInstancesRequest, IDeepCloneable ListInstancesRequest, IBufferMessage, IMessageNamespace
Google.Cloud.Spanner.Admin.Instance.V1Assembly
Google.Cloud.Spanner.Admin.Instance.V1.dll
Constructors
ListInstancesRequest()
public ListInstancesRequest()ListInstancesRequest(ListInstancesRequest)
public ListInstancesRequest(ListInstancesRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListInstancesRequest |
Properties
Filter
public string Filter { get; set; }An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
namedisplay_namelabels.keywhere key is the name of a label
Some examples of using filters are:
name:*--> The instance has a name.name:Howl--> The instance's name contains the string "howl".name:HOWL--> Equivalent to above.NAME:howl--> Equivalent to above.labels.env:*--> The instance has the label "env".labels.env:dev--> The instance has the label "env" and the value of the label contains the string "dev".name:howl labels.env:dev--> The instance's name contains "howl" and it has the label "env" with its value containing "dev".
| Property Value | |
|---|---|
| Type | Description |
string |
|
InstanceDeadline
public Timestamp InstanceDeadline { get; set; }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].
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
PageSize
public int PageSize { get; set; }Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
| Property Value | |
|---|---|
| Type | Description |
int |
|
PageToken
public string PageToken { get; set; }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].
| Property Value | |
|---|---|
| Type | Description |
string |
|
Parent
public string Parent { get; set; }Required. The name of the project for which a list of instances is
requested. Values are of the form projects/<project>.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ParentAsProjectName
public ProjectName ParentAsProjectName { get; set; }ProjectName-typed view over the Parent resource name property.
| Property Value | |
|---|---|
| Type | Description |
ProjectName |
|