Reference documentation and code samples for the Google Cloud Financial Services V1 Client class ListInstancesRequest.
Request for retrieving a paginated list of Instance resources that meet the specified criteria.
Generated from protobuf message google.cloud.financialservices.v1.ListInstancesRequest
Namespace
Google \ Cloud \ FinancialServices \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance. |
↳ page_size |
int
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. |
↳ page_token |
string
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. |
↳ filter |
string
Specify a filter to narrow search results. |
↳ order_by |
string
Specify a field to use for ordering. |
getParent
Required. The parent of the Instance is the location for that Instance.
Every location has exactly one instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent of the Instance is the location for that Instance.
Every location has exactly one instance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Specify a filter to narrow search results.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Specify a filter to narrow search results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Specify a field to use for ordering.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Specify a field to use for ordering.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent of the Instance is the location for that Instance. Every location has exactly one instance. Please see AMLClient::locationName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
ListInstancesRequest |
|