com.google.spanner.admin.instance.v1

Class ListInstancesRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.spanner.admin.instance.v1.ListInstancesRequest

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, ListInstancesRequestOrBuilder, java.io.Serializable

public final class ListInstancesRequest
extends GeneratedMessageV3
implements ListInstancesRequestOrBuilder

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

Protobuf type google.spanner.admin.instance.v1.ListInstancesRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListInstancesRequest.Builder The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static ListInstancesRequest	getDefaultInstance()
ListInstancesRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
java.lang.String	getFilter() An expression for filtering the results of the request.
ByteString	getFilterBytes() An expression for filtering the results of the request.
int	getPageSize() Number of instances to be returned in the response.
java.lang.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].
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].
java.lang.String	getParent() Required.
ByteString	getParentBytes() Required.
Parser<ListInstancesRequest>	getParserForType()
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListInstancesRequest.Builder	newBuilder()
static ListInstancesRequest.Builder	newBuilder(ListInstancesRequest prototype)
ListInstancesRequest.Builder	newBuilderForType()
protected ListInstancesRequest.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static ListInstancesRequest	parseDelimitedFrom(java.io.InputStream input)
static ListInstancesRequest	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static ListInstancesRequest	parseFrom(byte[] data)
static ListInstancesRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ListInstancesRequest	parseFrom(java.nio.ByteBuffer data)
static ListInstancesRequest	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static ListInstancesRequest	parseFrom(ByteString data)
static ListInstancesRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ListInstancesRequest	parseFrom(CodedInputStream input)
static ListInstancesRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ListInstancesRequest	parseFrom(java.io.InputStream input)
static ListInstancesRequest	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<ListInstancesRequest>	parser()
ListInstancesRequest.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getParent

public java.lang.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;

Specified by:

getParent in interface ListInstancesRequestOrBuilder

getParentBytes

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

Specified by:

getParentBytes in interface ListInstancesRequestOrBuilder

getPageSize

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

Specified by:

getPageSize in interface ListInstancesRequestOrBuilder

getPageToken

public java.lang.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;

Specified by:

getPageToken in interface ListInstancesRequestOrBuilder

getPageTokenBytes

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

Specified by:

getPageTokenBytes in interface ListInstancesRequestOrBuilder

getFilter

public java.lang.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;

Specified by:

getFilter in interface ListInstancesRequestOrBuilder

getFilterBytes

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

Specified by:

getFilterBytes in interface ListInstancesRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ListInstancesRequest parseFrom(java.nio.ByteBuffer data)
                                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListInstancesRequest parseFrom(java.nio.ByteBuffer data,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListInstancesRequest parseFrom(ByteString data)
                                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListInstancesRequest parseFrom(ByteString data,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListInstancesRequest parseFrom(byte[] data)
                                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListInstancesRequest parseFrom(byte[] data,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListInstancesRequest parseFrom(java.io.InputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ListInstancesRequest parseFrom(java.io.InputStream input,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ListInstancesRequest parseDelimitedFrom(java.io.InputStream input)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ListInstancesRequest parseDelimitedFrom(java.io.InputStream input,
                                                      ExtensionRegistryLite extensionRegistry)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ListInstancesRequest parseFrom(CodedInputStream input)
                                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ListInstancesRequest parseFrom(CodedInputStream input,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public ListInstancesRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ListInstancesRequest.Builder newBuilder()

newBuilder

public static ListInstancesRequest.Builder newBuilder(ListInstancesRequest prototype)

toBuilder

public ListInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ListInstancesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ListInstancesRequest getDefaultInstance()

parser

public static Parser<ListInstancesRequest> parser()

getParserForType

public Parser<ListInstancesRequest> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ListInstancesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder