Google Cloud Chronicle V1 Client - Class ListNativeDashboardsRequest (0.4.0)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class ListNativeDashboardsRequest.

Request message to list dashboards.

Generated from protobuf message google.cloud.chronicle.v1.ListNativeDashboardsRequest

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The parent owning this dashboard collection. Format: projects/{project}/locations/{location}/instances/{instance}

↳ page_size
int

Optional. The maximum number of dashboards to return. The service may return fewer than this value.

↳ page_token
string

Optional. A page token, received from a previous ListDashboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDashboards must match the call that provided the page token.

↳ view
int

Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.

getParent

Required. The parent owning this dashboard collection.

Format: projects/{project}/locations/{location}/instances/{instance}

Returns
Type
Description
string

setParent

Required. The parent owning this dashboard collection.

Format: projects/{project}/locations/{location}/instances/{instance}

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

Optional. The maximum number of dashboards to return. The service may return fewer than this value.

Returns
Type
Description
int

setPageSize

Optional. The maximum number of dashboards to return. The service may return fewer than this value.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

Optional. A page token, received from a previous ListDashboards call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDashboards must match the call that provided the page token.

Returns
Type
Description
string

setPageToken

Optional. A page token, received from a previous ListDashboards call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDashboards must match the call that provided the page token.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getView

Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.

Returns
Type
Description
int
Enum of type NativeDashboardView .

setView

Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.

Parameter
Name
Description
var
int

Enum of type NativeDashboardView .

Returns
Type
Description
$this

static::build

Parameter
Name
Description
parent
string

Required. The parent owning this dashboard collection. Format: projects/{project}/locations/{location}/instances/{instance} Please see NativeDashboardServiceClient::instanceName() for help formatting this field.

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: