Interface ListFeaturedContentNativeDashboardsRequestOrBuilder (0.31.0)

public interface ListFeaturedContentNativeDashboardsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String 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".

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public abstract int 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.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String 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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.