public static final class ListInstancesRequest.Builder extends GeneratedMessageV3.Builder<ListInstancesRequest.Builder> implements ListInstancesRequestOrBuilderThe request for ListInstances.
Protobuf type google.spanner.admin.instance.v1.ListInstancesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListInstancesRequest.BuilderImplements
ListInstancesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListInstancesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ListInstancesRequest.Builder |
build()
public ListInstancesRequest build()| Type | Description |
| ListInstancesRequest |
buildPartial()
public ListInstancesRequest buildPartial()| Type | Description |
| ListInstancesRequest |
clear()
public ListInstancesRequest.Builder clear()| Type | Description |
| ListInstancesRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListInstancesRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| ListInstancesRequest.Builder |
clearFilter()
public ListInstancesRequest.Builder clearFilter()An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
namedisplay_namelabels.keywhere 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;
| Type | Description |
| ListInstancesRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListInstancesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| ListInstancesRequest.Builder |
clearPageSize()
public ListInstancesRequest.Builder clearPageSize()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;
| Type | Description |
| ListInstancesRequest.Builder | This builder for chaining. |
clearPageToken()
public ListInstancesRequest.Builder clearPageToken() If non-empty, page_token should contain a
next_page_token from a
previous ListInstancesResponse.
string page_token = 3;
| Type | Description |
| ListInstancesRequest.Builder | This builder for chaining. |
clearParent()
public ListInstancesRequest.Builder clearParent() 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) = { ... }
| Type | Description |
| ListInstancesRequest.Builder | This builder for chaining. |
clone()
public ListInstancesRequest.Builder clone()| Type | Description |
| ListInstancesRequest.Builder |
getDefaultInstanceForType()
public ListInstancesRequest getDefaultInstanceForType()| Type | Description |
| ListInstancesRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getFilter()
public String getFilter()An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
namedisplay_namelabels.keywhere 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;
| Type | Description |
| String | The filter. |
getFilterBytes()
public ByteString getFilterBytes()An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
namedisplay_namelabels.keywhere 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;
| 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.
int32 page_size = 2;
| Type | Description |
| int | The pageSize. |
getPageToken()
public String getPageToken() If non-empty, page_token should contain a
next_page_token from a
previous ListInstancesResponse.
string page_token = 3;
| Type | Description |
| String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes() If non-empty, page_token should contain a
next_page_token from a
previous ListInstancesResponse.
string page_token = 3;
| Type | Description |
| ByteString | The bytes for pageToken. |
getParent()
public 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) = { ... }
| Type | Description |
| String | The parent. |
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 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| ByteString | The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListInstancesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListInstancesRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public ListInstancesRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| ListInstancesRequest.Builder |
mergeFrom(ListInstancesRequest other)
public ListInstancesRequest.Builder mergeFrom(ListInstancesRequest other)| Name | Description |
| other | ListInstancesRequest |
| Type | Description |
| ListInstancesRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListInstancesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ListInstancesRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListInstancesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ListInstancesRequest.Builder |
setFilter(String value)
public ListInstancesRequest.Builder setFilter(String value)An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
namedisplay_namelabels.keywhere 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;
| Name | Description |
| value | StringThe filter to set. |
| Type | Description |
| ListInstancesRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListInstancesRequest.Builder setFilterBytes(ByteString value)An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
namedisplay_namelabels.keywhere 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;
| Name | Description |
| value | ByteStringThe bytes for filter to set. |
| Type | Description |
| ListInstancesRequest.Builder | This builder for chaining. |
setPageSize(int value)
public ListInstancesRequest.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.
int32 page_size = 2;
| Name | Description |
| value | intThe pageSize to set. |
| Type | Description |
| ListInstancesRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListInstancesRequest.Builder setPageToken(String value) If non-empty, page_token should contain a
next_page_token from a
previous ListInstancesResponse.
string page_token = 3;
| Name | Description |
| value | StringThe pageToken to set. |
| Type | Description |
| ListInstancesRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListInstancesRequest.Builder setPageTokenBytes(ByteString value) If non-empty, page_token should contain a
next_page_token from a
previous ListInstancesResponse.
string page_token = 3;
| Name | Description |
| value | ByteStringThe bytes for pageToken to set. |
| Type | Description |
| ListInstancesRequest.Builder | This builder for chaining. |
setParent(String value)
public ListInstancesRequest.Builder setParent(String value) 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) = { ... }
| Name | Description |
| value | StringThe parent to set. |
| Type | Description |
| ListInstancesRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListInstancesRequest.Builder setParentBytes(ByteString value) 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) = { ... }
| Name | Description |
| value | ByteStringThe bytes for parent to set. |
| Type | Description |
| ListInstancesRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListInstancesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| ListInstancesRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListInstancesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ListInstancesRequest.Builder |