Reference documentation and code samples for the Google Cloud Financial Services V1 Client class ListBacktestResultsRequest.
Request for retrieving a paginated list of BacktestResult resources that meet the specified criteria.
Generated from protobuf message google.cloud.financialservices.v1.ListBacktestResultsRequest
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 BacktestResult is the 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 ListBacktestResultsResponse. It should be copied here to retrieve the next page of resources. Empty will give the first page of ListBacktestResultsRequest, and the last page will return an empty page_token. |
↳ 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 BacktestResult is the Instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent of the BacktestResult is the 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 ListBacktestResultsResponse. It should be copied here to retrieve the next page of resources. Empty will give the first page of ListBacktestResultsRequest, and the last page will return an empty page_token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
In case of paginated results, this is the token that was returned in the previous ListBacktestResultsResponse. It should be copied here to retrieve the next page of resources. Empty will give the first page of ListBacktestResultsRequest, and the last page will return an empty page_token.
| 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 BacktestResult is the Instance. Please see AMLClient::instanceName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
ListBacktestResultsRequest |
|