Method: moduleSettings.list

Full name: projects.locations.instances.moduleSettings.list

List ModuleSettings.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list ModuleSettings for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

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

string

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

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

string

Optional. Filter to be applied over multiple ModuleSettings fields. Only the following filters are allowed: "displayName:"

Request body

The request body must be empty.

Response body

Response message for moduleSettings.list.

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

JSON representation 
{
  "moduleSettings": [
    {
      object (ModuleSettings)
    }
  ],
  "nextPageToken": string
}
Fields
moduleSettings[]

object (ModuleSettings)

The list of ModuleSettings.
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.moduleSettings.get

For more information, see the IAM documentation.