public sealed class ListInstancesRequest : IMessage<ListInstancesRequest>, IEquatable<ListInstancesRequest>, IDeepCloneable<ListInstancesRequest>, IBufferMessage, IMessage, IPageRequest
Reference documentation and code samples for the Cloud Memorystore for Memcached v1 API class ListInstancesRequest.
Request for [ListInstances][google.cloud.memcache.v1.CloudMemcache.ListInstances].
Implements
IMessageListInstancesRequest, IEquatableListInstancesRequest, IDeepCloneableListInstancesRequest, IBufferMessage, IMessage, IPageRequestNamespace
Google.Cloud.Memcache.V1Assembly
Google.Cloud.Memcache.V1.dll
Constructors
ListInstancesRequest()
public ListInstancesRequest()
ListInstancesRequest(ListInstancesRequest)
public ListInstancesRequest(ListInstancesRequest other)
Parameter | |
---|---|
Name | Description |
other | ListInstancesRequest |
Properties
Filter
public string Filter { get; set; }
List filter. For example, exclude all Memcached instances with name as
my-instance by specifying "name != my-instance"
.
Property Value | |
---|---|
Type | Description |
string |
OrderBy
public string OrderBy { get; set; }
Sort results. Supported values are "name", "name desc" or "" (unsorted).
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
The maximum number of items to return.
If not specified, a default value of 1000 will be used by the service.
Regardless of the page_size
value, the response may include a partial
list and a caller should only rely on response's
[next_page_token
][google.cloud.memcache.v1.ListInstancesResponse.next_page_token]
to determine if there are more instances left to be queried.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
The next_page_token
value returned from a previous List request, if any.
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
where location_id
refers to a GCP region
Property Value | |
---|---|
Type | Description |
string |
ParentAsLocationName
public LocationName ParentAsLocationName { get; set; }
LocationName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
LocationName |