Method: properties.testSettings

Full name: projects.locations.instances.moduleSettings.properties.testSettings

The method tests the configured module settings, and by this ensures that all settings of the module were configured properly.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent resource where the module settings are located. Format: projects/{project}/locations/{location}/instances/{instance}/moduleSettings/{module}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "properties": [
    {
      object (ModuleSettingsProperty)
    }
  ]
}
Fields
properties[]

object (ModuleSettingsProperty)

Required. Properties to test Format: projects/{project}/locations/{location}/instances/{instance}/moduleSettings/{module}/properties/{property}

Response body

Response message for testSettings.

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

JSON representation 
{
  "success": boolean,
  "message": string
}
Fields
success

boolean

Did the test finish successfully
message

string

Execution message, if provided

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.