Class ListCloudInstancesAction.Builder (6.74.0)

public static final class ListCloudInstancesAction.Builder extends GeneratedMessageV3.Builder<ListCloudInstancesAction.Builder> implements ListCloudInstancesActionOrBuilder

Action that lists Cloud Spanner databases.

Protobuf type google.spanner.executor.v1.ListCloudInstancesAction

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListCloudInstancesAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListCloudInstancesAction.Builder
Overrides

build()

public ListCloudInstancesAction build()
Returns
Type Description
ListCloudInstancesAction

buildPartial()

public ListCloudInstancesAction buildPartial()
Returns
Type Description
ListCloudInstancesAction

clear()

public ListCloudInstancesAction.Builder clear()
Returns
Type Description
ListCloudInstancesAction.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListCloudInstancesAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListCloudInstancesAction.Builder
Overrides

clearFilter()

public ListCloudInstancesAction.Builder clearFilter()

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
ListCloudInstancesAction.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListCloudInstancesAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListCloudInstancesAction.Builder
Overrides

clearPageSize()

public ListCloudInstancesAction.Builder clearPageSize()

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
ListCloudInstancesAction.Builder

This builder for chaining.

clearPageToken()

public ListCloudInstancesAction.Builder clearPageToken()

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
ListCloudInstancesAction.Builder

This builder for chaining.

clearProjectId()

public ListCloudInstancesAction.Builder clearProjectId()

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

string project_id = 1;

Returns
Type Description
ListCloudInstancesAction.Builder

This builder for chaining.

clone()

public ListCloudInstancesAction.Builder clone()
Returns
Type Description
ListCloudInstancesAction.Builder
Overrides

getDefaultInstanceForType()

public ListCloudInstancesAction getDefaultInstanceForType()
Returns
Type Description
ListCloudInstancesAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListCloudInstancesAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListCloudInstancesAction.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListCloudInstancesAction.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListCloudInstancesAction.Builder
Overrides

mergeFrom(ListCloudInstancesAction other)

public ListCloudInstancesAction.Builder mergeFrom(ListCloudInstancesAction other)
Parameter
Name Description
other ListCloudInstancesAction
Returns
Type Description
ListCloudInstancesAction.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListCloudInstancesAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListCloudInstancesAction.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListCloudInstancesAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListCloudInstancesAction.Builder
Overrides

setFilter(String value)

public ListCloudInstancesAction.Builder setFilter(String value)

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;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListCloudInstancesAction.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListCloudInstancesAction.Builder setFilterBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListCloudInstancesAction.Builder

This builder for chaining.

setPageSize(int value)

public ListCloudInstancesAction.Builder setPageSize(int value)

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;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListCloudInstancesAction.Builder

This builder for chaining.

setPageToken(String value)

public ListCloudInstancesAction.Builder setPageToken(String value)

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;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListCloudInstancesAction.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListCloudInstancesAction.Builder setPageTokenBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListCloudInstancesAction.Builder

This builder for chaining.

setProjectId(String value)

public ListCloudInstancesAction.Builder setProjectId(String value)

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

string project_id = 1;

Parameter
Name Description
value String

The projectId to set.

Returns
Type Description
ListCloudInstancesAction.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public ListCloudInstancesAction.Builder setProjectIdBytes(ByteString value)

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

string project_id = 1;

Parameter
Name Description
value ByteString

The bytes for projectId to set.

Returns
Type Description
ListCloudInstancesAction.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListCloudInstancesAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListCloudInstancesAction.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListCloudInstancesAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListCloudInstancesAction.Builder
Overrides