Class ListCloudInstancesAction (6.89.0)

publicfinalclassListCloudInstancesActionextendsGeneratedMessageV3implementsListCloudInstancesActionOrBuilder

Action that lists Cloud Spanner databases.

Protobuf type google.spanner.executor.v1.ListCloudInstancesAction

Static Fields

FILTER_FIELD_NUMBER

publicstaticfinalintFILTER_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_SIZE_FIELD_NUMBER

publicstaticfinalintPAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

publicstaticfinalintPAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

publicstaticfinalintPROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

publicstaticListCloudInstancesActiongetDefaultInstance()
Returns
TypeDescription
ListCloudInstancesAction

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticListCloudInstancesAction.BuildernewBuilder()
Returns
TypeDescription
ListCloudInstancesAction.Builder

newBuilder(ListCloudInstancesAction prototype)

publicstaticListCloudInstancesAction.BuildernewBuilder(ListCloudInstancesActionprototype)
Parameter
NameDescription
prototypeListCloudInstancesAction
Returns
TypeDescription
ListCloudInstancesAction.Builder

parseDelimitedFrom(InputStream input)

publicstaticListCloudInstancesActionparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListCloudInstancesAction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListCloudInstancesActionparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCloudInstancesAction
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticListCloudInstancesActionparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListCloudInstancesAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticListCloudInstancesActionparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCloudInstancesAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticListCloudInstancesActionparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListCloudInstancesAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticListCloudInstancesActionparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCloudInstancesAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticListCloudInstancesActionparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListCloudInstancesAction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListCloudInstancesActionparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCloudInstancesAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticListCloudInstancesActionparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListCloudInstancesAction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListCloudInstancesActionparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCloudInstancesAction
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticListCloudInstancesActionparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListCloudInstancesAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticListCloudInstancesActionparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListCloudInstancesAction
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

publicstaticParser<ListCloudInstancesAction>parser()
Returns
TypeDescription
Parser<ListCloudInstancesAction>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

publicListCloudInstancesActiongetDefaultInstanceForType()
Returns
TypeDescription
ListCloudInstancesAction

getFilter()

publicStringgetFilter()

A filter expression that filters what operations are returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Refer spanner_instance_admin.proto.ListInstancesRequest for detail.

optional string filter = 2;

Returns
TypeDescription
String

The filter.

getFilterBytes()

publicByteStringgetFilterBytes()

A filter expression that filters what operations are returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Refer spanner_instance_admin.proto.ListInstancesRequest for detail.

optional string filter = 2;

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

publicintgetPageSize()

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

optional int32 page_size = 3;

Returns
TypeDescription
int

The pageSize.

getPageToken()

publicStringgetPageToken()

If non-empty, "page_token" should contain a next_page_token from a previous ListInstancesResponse to the same "parent" and with the same "filter".

optional string page_token = 4;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

publicByteStringgetPageTokenBytes()

If non-empty, "page_token" should contain a next_page_token from a previous ListInstancesResponse to the same "parent" and with the same "filter".

optional string page_token = 4;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParserForType()

publicParser<ListCloudInstancesAction>getParserForType()
Returns
TypeDescription
Parser<ListCloudInstancesAction>
Overrides

getProjectId()

publicStringgetProjectId()

Cloud project ID, e.g. "spanner-cloud-systest".

string project_id = 1;

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

publicByteStringgetProjectIdBytes()

Cloud project ID, e.g. "spanner-cloud-systest".

string project_id = 1;

Returns
TypeDescription
ByteString

The bytes for projectId.

getSerializedSize()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

hasFilter()

publicbooleanhasFilter()

A filter expression that filters what operations are returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Refer spanner_instance_admin.proto.ListInstancesRequest for detail.

optional string filter = 2;

Returns
TypeDescription
boolean

Whether the filter field is set.

hasPageSize()

publicbooleanhasPageSize()

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

optional int32 page_size = 3;

Returns
TypeDescription
boolean

Whether the pageSize field is set.

hasPageToken()

publicbooleanhasPageToken()

If non-empty, "page_token" should contain a next_page_token from a previous ListInstancesResponse to the same "parent" and with the same "filter".

optional string page_token = 4;

Returns
TypeDescription
boolean

Whether the pageToken field is set.

hashCode()

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicListCloudInstancesAction.BuildernewBuilderForType()
Returns
TypeDescription
ListCloudInstancesAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedListCloudInstancesAction.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListCloudInstancesAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

publicListCloudInstancesAction.BuildertoBuilder()
Returns
TypeDescription
ListCloudInstancesAction.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException