Class ListInstancesRequest (3.5.0)

public sealed class ListInstancesRequest : IPageRequest, IMessage<ListInstancesRequest>, IEquatable<ListInstancesRequest>, IDeepCloneable<ListInstancesRequest>, IBufferMessage, IMessage

The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].

Inheritance

Object > ListInstancesRequest

Implements

Google.Api.Gax.Grpc.IPageRequest, Google.Protobuf.IMessage<ListInstancesRequest>, IEquatable<ListInstancesRequest>, Google.Protobuf.IDeepCloneable<ListInstancesRequest>, Google.Protobuf.IBufferMessage, Google.Protobuf.IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Spanner.Admin.Instance.V1

Assembly

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:

name
display_name
labels.key where 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`

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
`Int32`

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; }

Google.Api.Gax.ResourceNames.ProjectName-typed view over the Parent resource name property.

Property Value
Type	Description
`Google.Api.Gax.ResourceNames.ProjectName`