Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class ListDataAgentsRequest.
Message for requesting list of DataAgents.
Generated from protobuf message google.cloud.geminidataanalytics.v1beta.ListDataAgentsRequest
Namespace
Google \ Cloud \ GeminiDataAnalytics \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Parent value for ListDataAgentsRequest. |
↳ page_size |
int
Optional. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
↳ page_token |
string
Optional. A page token, received from a previous |
↳ filter |
string
Optional. Filtering results. See AIP-160 for syntax. |
↳ order_by |
string
Optional. User specification for how to order the results. |
↳ show_deleted |
bool
Optional. If true, the list results will include soft-deleted DataAgents. Defaults to false. |
getParent
Required. Parent value for ListDataAgentsRequest.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. Parent value for ListDataAgentsRequest.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. Server may return fewer items than requested.
If unspecified, server will pick an appropriate default.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. Server may return fewer items than requested.
If unspecified, server will pick an appropriate default.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. A page token, received from a previous ListDataAgents call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDataAgents must
match the call that provided the page token. The service may return fewer
than this value.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token, received from a previous ListDataAgents call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListDataAgents must
match the call that provided the page token. The service may return fewer
than this value.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. Filtering results. See AIP-160 for syntax.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. Filtering results. See AIP-160 for syntax.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Optional. User specification for how to order the results.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Optional. User specification for how to order the results.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShowDeleted
Optional. If true, the list results will include soft-deleted DataAgents.
Defaults to false.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setShowDeleted
Optional. If true, the list results will include soft-deleted DataAgents.
Defaults to false.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. Parent value for ListDataAgentsRequest. Please see DataAgentServiceClient::locationName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
ListDataAgentsRequest |
|