Google Cloud Chronicle V1 Client - Class ListFeaturedContentNativeDashboardsRequest (0.4.0)

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

Request message to list FeaturedContentNativeDashboards.

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

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, which owns this collection of FeaturedContentNativeDashboards. Format: projects/{project}/locations/{location}/instances/{instance}/contentHub
↳ page_size int

Optional. The maximum number of FeaturedContentNativeDashboards to return. The service may return fewer than this value. If unspecified, at most 100 FeaturedContentNativeDashboards will be returned. The maximum value is 100; values above 100 will be coerced to 100.
↳ page_token string

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

Optional. The filter to apply to list the FeaturedContentNativeDashboards. The filter syntax follows Google Cloud syntax: https://google.aip.dev/160. Supported fields for filtering: * * name: The resource name of the featured content. * * content_metadata.description: The description of the featured content. When a literal value is provided without a field, it will perform a substring search across both name and content_metadata.description. Examples: * * "test": Matches featured content where either the name or description contains "test" as a substring. * * name="test": Matches featured content where the name contains "test". * * content_metadata.description="test": Matches featured content where the description contains "test".

getParent

Required. The parent, which owns this collection of FeaturedContentNativeDashboards. Format: projects/{project}/locations/{location}/instances/{instance}/contentHub

Returns
Type Description
string

setParent

Required. The parent, which owns this collection of FeaturedContentNativeDashboards. Format: projects/{project}/locations/{location}/instances/{instance}/contentHub

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of FeaturedContentNativeDashboards to return.

The service may return fewer than this value. If unspecified, at most 100 FeaturedContentNativeDashboards will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Returns
Type Description
int

setPageSize

Optional. The maximum number of FeaturedContentNativeDashboards to return.

The service may return fewer than this value. If unspecified, at most 100 FeaturedContentNativeDashboards will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A page token, received from a previous ListFeaturedContentNativeDashboards call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListFeaturedContentNativeDashboards must match the call that provided the page token.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous ListFeaturedContentNativeDashboards call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListFeaturedContentNativeDashboards must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. The filter to apply to list the FeaturedContentNativeDashboards.

The filter syntax follows Google Cloud syntax: https://google.aip.dev/160. Supported fields for filtering:

  • name: The resource name of the featured content.
  • content_metadata.description: The description of the featured content. When a literal value is provided without a field, it will perform a substring search across both name and content_metadata.description. Examples:
  • "test": Matches featured content where either the name or description contains "test" as a substring.
  • name="test": Matches featured content where the name contains "test".
  • content_metadata.description="test": Matches featured content where the description contains "test".
Returns
Type Description
string

setFilter

Optional. The filter to apply to list the FeaturedContentNativeDashboards.

The filter syntax follows Google Cloud syntax: https://google.aip.dev/160. Supported fields for filtering:

  • name: The resource name of the featured content.
  • content_metadata.description: The description of the featured content. When a literal value is provided without a field, it will perform a substring search across both name and content_metadata.description. Examples:
  • "test": Matches featured content where either the name or description contains "test" as a substring.
  • name="test": Matches featured content where the name contains "test".
  • content_metadata.description="test": Matches featured content where the description contains "test".
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent, which owns this collection of FeaturedContentNativeDashboards. Format: projects/{project}/locations/{location}/instances/{instance}/contentHub Please see FeaturedContentNativeDashboardServiceClient::contentHubName() for help formatting this field.
Returns
Type Description
ListFeaturedContentNativeDashboardsRequest