com.google.spanner.admin.instance.v1

Interface ListInstancesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListInstancesRequest, ListInstancesRequest.Builder

public interface ListInstancesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() An expression for filtering the results of the request.
com.google.protobuf.ByteString	getFilterBytes() An expression for filtering the results of the request.
int	getPageSize() Number of instances to be returned in the response.
String	getPageToken() 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].
com.google.protobuf.ByteString	getPageTokenBytes() 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].
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

 Required. The name of the project for which a list of instances is
 requested. Values are of the form `projects/<project>`.
 

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

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 Required. The name of the project for which a list of instances is
 requested. Values are of the form `projects/<project>`.
 

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

Returns:

The bytes for parent.

getPageSize

int getPageSize()

 Number of instances to be returned in the response. If 0 or less, defaults
 to the server's maximum allowed page size.
 

int32 page_size = 2;

Returns:

The pageSize.

getPageToken

String getPageToken()

 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].
 

string page_token = 3;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 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].
 

string page_token = 3;

Returns:

The bytes for pageToken.

getFilter

String getFilter()

 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".
 

string filter = 4;

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 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".
 

string filter = 4;

Returns:

The bytes for filter.