Class ListFeaturedContentNativeDashboardsRequest.Builder (0.31.0)

public static final class ListFeaturedContentNativeDashboardsRequest.Builder extends GeneratedMessage.Builder<ListFeaturedContentNativeDashboardsRequest.Builder> implements ListFeaturedContentNativeDashboardsRequestOrBuilder

Request message to list FeaturedContentNativeDashboards.

Protobuf type google.cloud.chronicle.v1.ListFeaturedContentNativeDashboardsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ListFeaturedContentNativeDashboardsRequest build()
Returns
Type Description
ListFeaturedContentNativeDashboardsRequest

buildPartial()

public ListFeaturedContentNativeDashboardsRequest buildPartial()
Returns
Type Description
ListFeaturedContentNativeDashboardsRequest

clear()

public ListFeaturedContentNativeDashboardsRequest.Builder clear()
Returns
Type Description
ListFeaturedContentNativeDashboardsRequest.Builder
Overrides

clearFilter()

public ListFeaturedContentNativeDashboardsRequest.Builder clearFilter()

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
ListFeaturedContentNativeDashboardsRequest.Builder

This builder for chaining.

clearPageSize()

public ListFeaturedContentNativeDashboardsRequest.Builder clearPageSize()

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
ListFeaturedContentNativeDashboardsRequest.Builder

This builder for chaining.

clearPageToken()

public ListFeaturedContentNativeDashboardsRequest.Builder clearPageToken()

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
ListFeaturedContentNativeDashboardsRequest.Builder

This builder for chaining.

clearParent()

public ListFeaturedContentNativeDashboardsRequest.Builder clearParent()

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
ListFeaturedContentNativeDashboardsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListFeaturedContentNativeDashboardsRequest getDefaultInstanceForType()
Returns
Type Description
ListFeaturedContentNativeDashboardsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

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

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListFeaturedContentNativeDashboardsRequest other)

public ListFeaturedContentNativeDashboardsRequest.Builder mergeFrom(ListFeaturedContentNativeDashboardsRequest other)
Parameter
Name Description
other ListFeaturedContentNativeDashboardsRequest
Returns
Type Description
ListFeaturedContentNativeDashboardsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListFeaturedContentNativeDashboardsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListFeaturedContentNativeDashboardsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListFeaturedContentNativeDashboardsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListFeaturedContentNativeDashboardsRequest.Builder
Overrides

setFilter(String value)

public ListFeaturedContentNativeDashboardsRequest.Builder setFilter(String value)

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];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListFeaturedContentNativeDashboardsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListFeaturedContentNativeDashboardsRequest.Builder setFilterBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListFeaturedContentNativeDashboardsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListFeaturedContentNativeDashboardsRequest.Builder setPageSize(int value)

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];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListFeaturedContentNativeDashboardsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListFeaturedContentNativeDashboardsRequest.Builder setPageToken(String value)

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];

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListFeaturedContentNativeDashboardsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListFeaturedContentNativeDashboardsRequest.Builder setPageTokenBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListFeaturedContentNativeDashboardsRequest.Builder

This builder for chaining.

setParent(String value)

public ListFeaturedContentNativeDashboardsRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListFeaturedContentNativeDashboardsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListFeaturedContentNativeDashboardsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListFeaturedContentNativeDashboardsRequest.Builder

This builder for chaining.