Method: featuredContentRules.list

Full name: projects.locations.instances.contentHub.featuredContentRules.list

Lists FeaturedContentRules

HTTP request


Path parameters

Parameters
parent

string

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

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of featured contents to return. The service may return fewer than this value. If unspecified, at most 100 featured contents will be returned. The maximum value is 1000; values above 1000 will be coerced to 100.
pageToken

string

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

string

Optional. Only the following filters are allowed: Under HAS operator: Filtering through category names: - Singular: categoryName:"<categoryName>" - Multiple: categoryName:"<category_name1>" OR categoryName:"<category_name2>" -- You can only use OR operator between multiple categoryName filters.

Filtering through policy names: - Singular: policyName:"<policyName>" - Multiple: policyName:"<policy_name1>" OR policyName:"<policy_name2>" -- You can only use OR operator between multiple policyName filters.

Filtering through rule IDs: - Singular: ruleId:"ur_<id>" - Multiple: ruleId:"ur_<rule_id1>" OR ruleId:"ur_<rule_id2>" -- You can only use OR operator between multiple ruleId filters.

Filtering through rule precision: rule_precision:"<rule_precision>" -- Rule precision values can be "Precise" or "Broad". If something else is passed, the rule precision will default to "Unknown". You can only filter by one rule precision value.

Under MATCHES_REGEXP operator: Search through rule name or description (behaves like a string contains): This search is case-insensitive and filters through the rule metadata, specifically the ruleName and description keys. search_rule_name_or_description=~"<ruleName> or <rule_description>". You can only filter by one rule name or description value.

Multiple filters can also be used together: Ex 1: categoryName:"<categoryName>" AND policyName:"<policyName>" Ex 2: Since categoryName and policyName are repeated fields, we can also use multiple values for each: (categoryName:"<category_name1>" OR categoryName:"<category_name2>") AND policyName:"<policyName>" -- Note that the AND operator has higher precedence than the OR operator. Additionally, parentheses must be used to create a valid filter.

Requests using filter comparators other than HAS(:) or MATCHES_REGEXP(=~) will result in an InvalidArgument error.

Request body

The request body must be empty.

Response body

Response message for featuredContentRules.list method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "featuredContentRules": [
    {
      object (FeaturedContentRule)
    }
  ],
  "nextPageToken": string
}
Fields
featuredContentRules[]

object (FeaturedContentRule)

The list of FeaturedContentRules.
nextPageToken

string

Optional. A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.featuredContentRules.list

For more information, see the IAM documentation.

FeaturedContentRule

FeaturedContentRule resource. Next ID: 14

JSON representation 
{
  "name": string,
  "contentMetadata": {
    object (FeaturedContentMetadata)
  },
  "curatedRuleContent": {
    object (CuratedRule)
  },
  "ruleText": string,
  "ruleTextHidden": boolean,
  "ruleAssumption": string,
  "severity": enum (RuleSeverity),
  "alertingStatusEnabled": boolean,
  "liveStatusEnabled": boolean,
  "ruleEntitlement": enum (RuleEntitlement),
  "categoryId": string,
  "ruleSet": {
    object (RuleSet)
  },
  "privateRule": boolean
}
Fields
name

string

Identifier. Full resource name for the FeaturedContentRule. Format: projects/{project}/locations/{location}/instances/{instance}/contentHub/featuredContentRules/{featuredContentRule}
contentMetadata

object (FeaturedContentMetadata)

Output only. Metadata for all teams.
curatedRuleContent

object (CuratedRule)

Optional. The curated rule content.
ruleText

string

Output only. Rule text.
ruleTextHidden

boolean

Indicates if the curated rule text is hidden due to missing feature flags.
ruleAssumption

string

Output only. The assumption of the rule.
severity

enum (RuleSeverity)

Output only. The severity of the rule.
alertingStatusEnabled

boolean

Alerting status for the curated rule.
liveStatusEnabled

boolean

Live status for the curated rule.
ruleEntitlement

enum (RuleEntitlement)

Indicates the entitlement of the curated rule.
categoryId

string

Output only. The category pack ID of the curated rule.
ruleSet

object (RuleSet)

Output only. The rule set information for the curated rule.
privateRule

boolean

Output only. Indicates if the curated rule is private. If rule is marked as private, the rule text will be hidden.

RuleSeverity

RuleSeverity is an enum representing the severity of the rule.

Enums
RULE_SEVERITY_UNSPECIFIED Unspecified severity.
LOW Rule is set to low severity.
MEDIUM Rule is set to medium severity.
HIGH Rule is set to high severity.
CRITICAL Rule is set to critical severity.

RuleEntitlement

Represents the rule entitlement for FeaturedContentRule.

Enums
RULE_ENTITLEMENT_UNSPECIFIED Unspecified entitlement.
ENTERPRISE Enterprise entitlement.
ENTERPRISE_PLUS Enterprise Plus entitlement.

RuleSet

Represents the rule set information for a FeaturedContentRule.

JSON representation 
{
  "curatedRuleSet": string,
  "id": string,
  "displayName": string
}
Fields
curatedRuleSet

string

Output only. The parent CuratedRuleSet that the rule set belongs to. Format: projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{category}/curatedRuleSets/{ruleSet}
id

string

The hash of the rule set.
displayName

string

The human readable name of the rule set.