Class ListCloudInstancesAction (6.83.0)

public final class ListCloudInstancesAction extends GeneratedMessageV3 implements ListCloudInstancesActionOrBuilder

Action that lists Cloud Spanner databases.

Protobuf type google.spanner.executor.v1.ListCloudInstancesAction

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListCloudInstancesAction getDefaultInstance()
Returns
Type Description
ListCloudInstancesAction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListCloudInstancesAction.Builder newBuilder()
Returns
Type Description
ListCloudInstancesAction.Builder

newBuilder(ListCloudInstancesAction prototype)

public static ListCloudInstancesAction.Builder newBuilder(ListCloudInstancesAction prototype)
Parameter
Name Description
prototype ListCloudInstancesAction
Returns
Type Description
ListCloudInstancesAction.Builder

parseDelimitedFrom(InputStream input)

public static ListCloudInstancesAction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListCloudInstancesAction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCloudInstancesAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCloudInstancesAction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListCloudInstancesAction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListCloudInstancesAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListCloudInstancesAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCloudInstancesAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListCloudInstancesAction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListCloudInstancesAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListCloudInstancesAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCloudInstancesAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListCloudInstancesAction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListCloudInstancesAction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCloudInstancesAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCloudInstancesAction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListCloudInstancesAction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListCloudInstancesAction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListCloudInstancesAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCloudInstancesAction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListCloudInstancesAction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListCloudInstancesAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListCloudInstancesAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCloudInstancesAction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListCloudInstancesAction> parser()
Returns
Type Description
Parser<ListCloudInstancesAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListCloudInstancesAction getDefaultInstanceForType()
Returns
Type Description
ListCloudInstancesAction

getFilter()

public String getFilter()

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
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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
Type Description
ByteString

The bytes for filter.

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.

optional int32 page_size = 3;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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
Type Description
ByteString

The bytes for pageToken.

getParserForType()

public Parser<ListCloudInstancesAction> getParserForType()
Returns
Type Description
Parser<ListCloudInstancesAction>
Overrides

getProjectId()

public String getProjectId()

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

string project_id = 1;

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

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

string project_id = 1;

Returns
Type Description
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasFilter()

public boolean hasFilter()

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
Type Description
boolean

Whether the filter field is set.

hasPageSize()

public boolean hasPageSize()

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
Type Description
boolean

Whether the pageSize field is set.

hasPageToken()

public boolean hasPageToken()

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
Type Description
boolean

Whether the pageToken field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListCloudInstancesAction.Builder newBuilderForType()
Returns
Type Description
ListCloudInstancesAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListCloudInstancesAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListCloudInstancesAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListCloudInstancesAction.Builder toBuilder()
Returns
Type Description
ListCloudInstancesAction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException