public sealed class ListInstancesRequest : IPageRequest, IMessage<ListInstancesRequest>, IEquatable<ListInstancesRequest>, IDeepCloneable<ListInstancesRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the AlloyDB v1 API class ListInstancesRequest.
Message for requesting list of Instances
Implements
IPageRequest, IMessageListInstancesRequest, IEquatableListInstancesRequest, IDeepCloneableListInstancesRequest, IBufferMessage, IMessageNamespace
Google.Cloud.AlloyDb.V1Assembly
Google.Cloud.AlloyDb.V1.dll
Constructors
ListInstancesRequest()
public ListInstancesRequest()
ListInstancesRequest(ListInstancesRequest)
public ListInstancesRequest(ListInstancesRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListInstancesRequest |
Properties
Filter
public string Filter { get; set; }
Optional. Filtering results
Property Value | |
---|---|
Type | Description |
string |
OrderBy
public string OrderBy { get; set; }
Optional. Hint for how to order the results
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
A token identifying a page of results the server should return.
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats:
- projects/{project}/locations/-/clusters/-
- projects/{project}/locations/{region}/clusters/-
Property Value | |
---|---|
Type | Description |
string |
ParentAsClusterName
public ClusterName ParentAsClusterName { get; set; }
ClusterName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
ClusterName |