Method: projects.rules.metadata.list

Stay organized with collections Save and categorize content based on your preferences.

List all rule metadata for a given rule identifier.

HTTP request

GET https://issuerswitch.googleapis.com/v1/{parent}/metadata

Path parameters

Parameters
parent

string

Required. The parent resource. The format is projects/{project}/rules/{rule}.

Query parameters

Parameters
pageSize

integer

The maximum number of rule metadata to return. The service may return fewer than this value. If unspecified or if the specified value is less than 50, at most 50 rule metadata will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

A page token, received from a previous ListRuleMetadataRequest call. Specify this parameter to retrieve the next page of rule metadata.

Request body

The request body must be empty.

Response body

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

Response body for the metadata.list method.

JSON representation
{
  "ruleMetadata": [
    {
      object (RuleMetadata)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Fields
ruleMetadata[]

object (RuleMetadata)

List of rule metadata associated with the rule.

nextPageToken

string

Pass this token in a subsequent ListRuleMetadataRequest call to continue to list results. If all results have been returned, this field is an empty string or not present in the response.

totalSize

string (int64 format)

Total number of rule metadata matching request criteria across all pages.

Authorization Scopes

Requires the following OAuth scope:

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

IAM Permissions

Requires the following IAM permission on the parent resource:

  • issuerswitch.ruleMetadata.list

For more information, see the IAM documentation.

RuleMetadata

The metadata associated with a rule. This defines data that are used by the rule during execution.

JSON representation
{
  "name": string,
  "description": string,
  "type": enum (Type)
}
Fields
name

string

The unique identifier for this resource. Format: projects/{project}/rules/{rule}/metadata/{metadata}

description

string

The description of the rule metadata.

type

enum (Type)

Type of rule metadata.

Type

The type of metadata.

Enums
TYPE_UNSPECIFIED Unspecified type.
LIST List type. Indicates that the metadata contains a list of values which the rule requires for execution.