Interface ListInstancesRequestOrBuilder (2.23.0)

Version 2.23.0

• 2.54.0 (latest)
• 2.53.0
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.6
• 2.2.1
• 2.1.11

public interface ListInstancesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

List filter. For example, exclude all Memcached instances with name as my-instance by specifying "name != my-instance".

string filter = 4;

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

List filter. For example, exclude all Memcached instances with name as my-instance by specifying "name != my-instance".

string filter = 4;

Returns
Type	Description
ByteString	The bytes for filter.

getOrderBy()

public abstract String getOrderBy()

Sort results. Supported values are "name", "name desc" or "" (unsorted).

string order_by = 5;

Returns
Type	Description
String	The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

Sort results. Supported values are "name", "name desc" or "" (unsorted).

string order_by = 5;

Returns
Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

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 to determine if there are more instances left to be queried.

int32 page_size = 2;

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

The next_page_token value returned from a previous List request, if any.

string page_token = 3;

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

The next_page_token value returned from a previous List request, if any.

string page_token = 3;

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public abstract String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.