Google Cloud Gemini Data Analytics V1beta Client - Class ListAccessibleDataAgentsRequest (0.1.1)

Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class ListAccessibleDataAgentsRequest.

Message for requesting list of accessible DataAgents.

Generated from protobuf message google.cloud.geminidataanalytics.v1beta.ListAccessibleDataAgentsRequest

Namespace

Google \ Cloud \ GeminiDataAnalytics \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Parent value for ListAccessibleDataAgentsRequest.

↳ 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 ListAccessibleDataAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAccessibleDataAgents must match the call that provided the page token. The service may return fewer than this value.

↳ 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.

↳ creator_filter int

Optional. Filter for the creator of the agent.

getParent

Required. Parent value for ListAccessibleDataAgentsRequest.

Returns
Type Description
string

setParent

Required. Parent value for ListAccessibleDataAgentsRequest.

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 ListAccessibleDataAgents call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAccessibleDataAgents 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 ListAccessibleDataAgents call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAccessibleDataAgents 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

getCreatorFilter

Optional. Filter for the creator of the agent.

Returns
Type Description
int

setCreatorFilter

Optional. Filter for the creator of the agent.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Parent value for ListAccessibleDataAgentsRequest. Please see DataAgentServiceClient::locationName() for help formatting this field.

Returns
Type Description
ListAccessibleDataAgentsRequest