META-INF.apidocs.nl.praegus.fitnesse.slim.fixtures.azure.KeyVaultSecrets.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of toolchain-fixtures Show documentation
Extensions on existing fixtures to aid in automated testing
There is a newer version: 1.38.1
{
  "constructors" : [ {
    "readableName" : "key vault secrets",
    "usage" : "| key vault secrets | [vaultName] |",
    "name" : "KeyVaultSecrets",
    "docString" : "Instantiate this fixture and create a key vault SecretClient for a named vault.\n To authenticate, a default Azure credential is used. (see: ...)\n To use Environment Credential, set the following environment variables:\n AZURE_CLIENT_ID: [CLIENT_ID]\n AZURE_TENANT_ID: [TENANT_ID]\n AZURE_CLIENT_SECRET: [CLIENT_SECRET]\n Access to the vault should be governed using an app registration for this fixture in your Azure AD.\n Client- and tenant id are on the app registration page. A client secret can be generated there.\n@param vaultName The name of the key vault as configured in Azure",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "vaultName",
      "description" : "The name of the key vault as configured in Azure",
      "type" : "String"
    } ],
    "exceptions" : [ ]
  } ],
  "qualifiedName" : "nl.praegus.fitnesse.slim.fixtures.azure.KeyVaultSecrets",
  "publicMethods" : [ {
    "readableName" : "retrieve secret",
    "usage" : "| retrieve secret | [secretName] | ",
    "contexthelp" : "retrieve secret <secretName>",
    "name" : "retrieveSecret",
    "docString" : "Retrieve a secret by its name and set it to slim symbol $SECRET_[secretName]\n@param secretName The name of the secret to retrieve\n@return true if secret can be retrieved. Throws a slimFixtureException with the error message otherwise.",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "secretName",
      "description" : "The name of the secret to retrieve",
      "type" : "String"
    } ],
    "exceptions" : [ ],
    "returnType" : "boolean"
  }, {
    "readableName" : "set statement executor",
    "usage" : "| set statement executor | [statementExecutor] | ",
    "contexthelp" : "set statement executor <statementExecutor>",
    "name" : "setStatementExecutor",
    "docString" : "This method is used to provide the statement executor context and should never be called from your test\n@param statementExecutor --",
    "annotations" : [ "Override" ],
    "parameters" : [ {
      "name" : "statementExecutor",
      "description" : "--",
      "type" : "StatementExecutorInterface"
    } ],
    "exceptions" : [ ],
    "returnType" : "void"
  }, {
    "readableName" : "set global value to",
    "usage" : "| set global value | [symbolName] | to | [value] | ",
    "contexthelp" : "set global value <symbolName> to <value>",
    "name" : "setGlobalValueTo",
    "docString" : "Stores a (global) value so it can be accessed by other fixtures/pages.\n@param symbolName name to store value under.\n@param value value to store.",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "symbolName",
      "description" : "name to store value under.",
      "type" : "String"
    }, {
      "name" : "value",
      "description" : "value to store.",
      "type" : "String"
    } ],
    "exceptions" : [ ],
    "returnType" : "void"
  }, {
    "readableName" : "global value",
    "usage" : "| global value | [symbolName] | ",
    "contexthelp" : "global value <symbolName>",
    "name" : "globalValue",
    "docString" : "Retrieves a (global) value, which was previously stored using #setGlobalValueTo().\n@param symbolName name value was stored under.",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "symbolName",
      "description" : "name value was stored under.",
      "type" : "String"
    } ],
    "exceptions" : [ ],
    "returnType" : "String"
  }, {
    "readableName" : "wait seconds",
    "usage" : "| wait seconds | [i] | ",
    "contexthelp" : "wait seconds <i>",
    "name" : "waitSeconds",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "i",
      "type" : "int"
    } ],
    "exceptions" : [ ],
    "returnType" : "boolean"
  }, {
    "readableName" : "wait milliseconds",
    "usage" : "| wait milliseconds | [i] | ",
    "contexthelp" : "wait milliseconds <i>",
    "name" : "waitMilliseconds",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "i",
      "type" : "int"
    } ],
    "exceptions" : [ ],
    "returnType" : "boolean"
  }, {
    "readableName" : "set repeat interval to milliseconds",
    "usage" : "| set repeat interval to milliseconds | [milliseconds] | ",
    "contexthelp" : "set repeat interval to milliseconds <milliseconds>",
    "name" : "setRepeatIntervalToMilliseconds",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "milliseconds",
      "type" : "int"
    } ],
    "exceptions" : [ ],
    "returnType" : "void"
  }, {
    "readableName" : "repeat interval",
    "usage" : "| repeat interval |",
    "contexthelp" : "repeat interval",
    "name" : "repeatInterval",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "long"
  }, {
    "readableName" : "repeat at most times",
    "usage" : "| repeat at most times | [maxCount] | ",
    "contexthelp" : "repeat at most times <maxCount>",
    "name" : "repeatAtMostTimes",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ {
      "name" : "maxCount",
      "type" : "int"
    } ],
    "exceptions" : [ ],
    "returnType" : "void"
  }, {
    "readableName" : "repeat at most times",
    "usage" : "| repeat at most times |",
    "contexthelp" : "repeat at most times",
    "name" : "repeatAtMostTimes",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "int"
  }, {
    "readableName" : "repeat count",
    "usage" : "| repeat count |",
    "contexthelp" : "repeat count",
    "name" : "repeatCount",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "int"
  }, {
    "readableName" : "time spent repeating",
    "usage" : "| time spent repeating |",
    "contexthelp" : "time spent repeating",
    "name" : "timeSpentRepeating",
    "docString" : "",
    "annotations" : [ ],
    "parameters" : [ ],
    "exceptions" : [ ],
    "returnType" : "long"
  } ],
  "typeName" : "nl.praegus.fitnesse.slim.fixtures.azure.KeyVaultSecrets",
  "name" : "KeyVaultSecrets",
  "annotations" : [ ]
}