public static final class ListInstancesRequest.Builder extends GeneratedMessageV3.Builder<ListInstancesRequest.Builder> implements ListInstancesRequestOrBuilder
Request for retrieving a paginated list of Instance resources that meet the specified criteria.
Protobuf type google.cloud.financialservices.v1.ListInstancesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListInstancesRequest.BuilderImplements
ListInstancesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListInstancesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
build()
public ListInstancesRequest build()
Returns | |
---|---|
Type | Description |
ListInstancesRequest |
buildPartial()
public ListInstancesRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListInstancesRequest |
clear()
public ListInstancesRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListInstancesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
clearFilter()
public ListInstancesRequest.Builder clearFilter()
Specify a filter to narrow search results.
string filter = 4;
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListInstancesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
clearOrderBy()
public ListInstancesRequest.Builder clearOrderBy()
Specify a field to use for ordering.
string order_by = 5;
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
clearPageSize()
public ListInstancesRequest.Builder clearPageSize()
The number of resources to be included in the response. The response contains a next_page_token, which can be used to retrieve the next page of resources.
int32 page_size = 2;
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListInstancesRequest.Builder clearPageToken()
In case of paginated results, this is the token that was returned in the previous ListInstancesResponse. It should be copied here to retrieve the next page of resources. This will be empty for the first instance of ListInstancesRequest.
string page_token = 3;
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
clearParent()
public ListInstancesRequest.Builder clearParent()
Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
clone()
public ListInstancesRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
getDefaultInstanceForType()
public ListInstancesRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListInstancesRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getFilter()
public String getFilter()
Specify a filter to narrow search results.
string filter = 4;
Returns | |
---|---|
Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()
Specify a filter to narrow search results.
string filter = 4;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for filter. |
getOrderBy()
public String getOrderBy()
Specify a field to use for ordering.
string order_by = 5;
Returns | |
---|---|
Type | Description |
String |
The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes()
Specify a field to use for ordering.
string order_by = 5;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for orderBy. |
getPageSize()
public int getPageSize()
The number of resources to be included in the response. The response contains a next_page_token, which can be used to retrieve the next page of resources.
int32 page_size = 2;
Returns | |
---|---|
Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken()
In case of paginated results, this is the token that was returned in the previous ListInstancesResponse. It should be copied here to retrieve the next page of resources. This will be empty for the first instance of ListInstancesRequest.
string page_token = 3;
Returns | |
---|---|
Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
In case of paginated results, this is the token that was returned in the previous ListInstancesResponse. It should be copied here to retrieve the next page of resources. This will be empty for the first instance of ListInstancesRequest.
string page_token = 3;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public String getParent()
Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes()
Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ListInstancesRequest other)
public ListInstancesRequest.Builder mergeFrom(ListInstancesRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListInstancesRequest |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListInstancesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListInstancesRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListInstancesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListInstancesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
setFilter(String value)
public ListInstancesRequest.Builder setFilter(String value)
Specify a filter to narrow search results.
string filter = 4;
Parameter | |
---|---|
Name | Description |
value |
String The filter to set. |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListInstancesRequest.Builder setFilterBytes(ByteString value)
Specify a filter to narrow search results.
string filter = 4;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public ListInstancesRequest.Builder setOrderBy(String value)
Specify a field to use for ordering.
string order_by = 5;
Parameter | |
---|---|
Name | Description |
value |
String The orderBy to set. |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListInstancesRequest.Builder setOrderByBytes(ByteString value)
Specify a field to use for ordering.
string order_by = 5;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for orderBy to set. |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListInstancesRequest.Builder setPageSize(int value)
The number of resources to be included in the response. The response contains a next_page_token, which can be used to retrieve the next page of resources.
int32 page_size = 2;
Parameter | |
---|---|
Name | Description |
value |
int The pageSize to set. |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListInstancesRequest.Builder setPageToken(String value)
In case of paginated results, this is the token that was returned in the previous ListInstancesResponse. It should be copied here to retrieve the next page of resources. This will be empty for the first instance of ListInstancesRequest.
string page_token = 3;
Parameter | |
---|---|
Name | Description |
value |
String The pageToken to set. |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListInstancesRequest.Builder setPageTokenBytes(ByteString value)
In case of paginated results, this is the token that was returned in the previous ListInstancesResponse. It should be copied here to retrieve the next page of resources. This will be empty for the first instance of ListInstancesRequest.
string page_token = 3;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListInstancesRequest.Builder setParent(String value)
Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListInstancesRequest.Builder setParentBytes(ByteString value)
Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for parent to set. |
Returns | |
---|---|
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)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListInstancesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListInstancesRequest.Builder |