ibm-cloud-sdk-core 4.0.0 → 4.0.2

package/es/auth/authenticators/authenticator-interface.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -34,9 +34,8 @@ export interface AuthenticatorInterface {
     /**
      * Add authentication information to the specified request.
      *
-     * @param {object} requestOptions The request to augment with authentication information.
-     * @param {object.<string, string>} requestOptions.headers The headers the
-     *   authentication information will be added to.
+     * @param requestOptions - The request to which authentication information is added
+     * (in the headers field).
      */
     authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**

package/es/auth/authenticators/authenticator-interface.js

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

package/es/auth/authenticators/authenticator.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -33,25 +33,21 @@ export declare class Authenticator implements AuthenticatorInterface {
     /**
      * Create a new Authenticator instance.
      *
-     * @throws {Error} The `new` keyword was not used to create construct the
-     *   authenticator.
+     * @throws Error: the "new" keyword was not used to construct the authenticator.
      */
     constructor();
     /**
      * Augment the request with authentication information.
      *
-     * @param {object} requestOptions - The request to augment with authentication information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added too.
-     * @throws {Error} - The authenticate method was not implemented by a
-     *   subclass.
+     * @param requestOptions - The request to augment with authentication information.
+     * @throws Error: The authenticate method was not implemented by a subclass.
      */
     authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
      * Retrieves the authenticator's type.
      * The returned value will be the same string that is used
      * when configuring an instance of the authenticator with the
-     * "<service_name>_AUTH_TYPE" configuration property
+     * \<service_name\>_AUTH_TYPE configuration property
      * (e.g. "basic", "iam", etc.).
      * This function should be overridden in each authenticator
      * implementation class that extends this class.

package/es/auth/authenticators/authenticator.js

@@ -7,8 +7,7 @@ export class Authenticator {
     /**
      * Create a new Authenticator instance.
      *
-     * @throws {Error} The `new` keyword was not used to create construct the
-     *   authenticator.
+     * @throws Error: the "new" keyword was not used to construct the authenticator.
      */
     constructor() {
         if (!(this instanceof Authenticator)) {
@@ -18,11 +17,8 @@ export class Authenticator {
     /**
      * Augment the request with authentication information.
      *
-     * @param {object} requestOptions - The request to augment with authentication information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added too.
-     * @throws {Error} - The authenticate method was not implemented by a
-     *   subclass.
+     * @param requestOptions - The request to augment with authentication information.
+     * @throws Error: The authenticate method was not implemented by a subclass.
      */
     authenticate(requestOptions) {
         const error = new Error('Should be implemented by subclass!');
@@ -32,7 +28,7 @@ export class Authenticator {
      * Retrieves the authenticator's type.
      * The returned value will be the same string that is used
      * when configuring an instance of the authenticator with the
-     * "<service_name>_AUTH_TYPE" configuration property
+     * \<service_name\>_AUTH_TYPE configuration property
      * (e.g. "basic", "iam", etc.).
      * This function should be overridden in each authenticator
      * implementation class that extends this class.

package/es/auth/authenticators/basic-authenticator.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,7 +28,7 @@ export type Options = {
  *
  * Basic Authorization will be sent as an Authorization header in the form:
  *
- *     Authorization: Basic <encoded username and password>
+ *     Authorization: Basic \<encoded username and password\>
  *
  */
 export declare class BasicAuthenticator extends Authenticator {
@@ -39,21 +39,21 @@ export declare class BasicAuthenticator extends Authenticator {
     /**
      * Create a new BasicAuthenticator instance.
      *
-     * @param {object} options Configuration options for basic authentication.
-     * @param {string} options.username The username portion of basic authentication.
-     * @param {string} options.password The password portion of basic authentication.
-     * @throws {Error} The configuration options are not valid.
+     * @param options - Configuration options for basic authentication.
+     * This should be an object containing these fields:
+     * - username: the username portion of basic authentication
+     * - password: the password portion of basic authentication
+     *
+     * @throws Error: the configuration options are not valid.
      */
     constructor(options: Options);
     /**
-     * Add basic authentication information to `request`. The basic authentication information
-     * will be set in the Authorization property of`request.headers` in the form:
+     * Add basic authentication information to `requestOptions`. The basic authentication information
+     * will be set in the Authorization property of `requestOptions.headers` in the form:
      *
-     *     Authorization: Basic <encoded username and password>
+     *     Authorization: Basic \<encoded username and password\>
      *
-     * @param {object} requestOptions - The request to augment with authentication information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added too.
+     * @param requestOptions - The request to augment with authentication information.
      */
     authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**

package/es/auth/authenticators/basic-authenticator.js

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,17 +22,19 @@ import { Authenticator } from './authenticator';
  *
  * Basic Authorization will be sent as an Authorization header in the form:
  *
- *     Authorization: Basic <encoded username and password>
+ *     Authorization: Basic \<encoded username and password\>
  *
  */
 export class BasicAuthenticator extends Authenticator {
     /**
      * Create a new BasicAuthenticator instance.
      *
-     * @param {object} options Configuration options for basic authentication.
-     * @param {string} options.username The username portion of basic authentication.
-     * @param {string} options.password The password portion of basic authentication.
-     * @throws {Error} The configuration options are not valid.
+     * @param options - Configuration options for basic authentication.
+     * This should be an object containing these fields:
+     * - username: the username portion of basic authentication
+     * - password: the password portion of basic authentication
+     *
+     * @throws Error: the configuration options are not valid.
      */
     constructor(options) {
         super();
@@ -43,14 +45,12 @@ export class BasicAuthenticator extends Authenticator {
         this.authHeader = { Authorization: authHeaderString };
     }
     /**
-     * Add basic authentication information to `request`. The basic authentication information
-     * will be set in the Authorization property of`request.headers` in the form:
+     * Add basic authentication information to `requestOptions`. The basic authentication information
+     * will be set in the Authorization property of `requestOptions.headers` in the form:
      *
-     *     Authorization: Basic <encoded username and password>
+     *     Authorization: Basic \<encoded username and password\>
      *
-     * @param {object} requestOptions - The request to augment with authentication information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added too.
+     * @param requestOptions - The request to augment with authentication information.
      */
     authenticate(requestOptions) {
         return new Promise((resolve) => {

package/es/auth/authenticators/bearer-token-authenticator.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,7 +26,7 @@ export type Options = {
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export declare class BearerTokenAuthenticator extends Authenticator {
     protected requiredOptions: string[];
@@ -34,29 +34,26 @@ export declare class BearerTokenAuthenticator extends Authenticator {
     /**
      * Create a new BearerTokenAuthenticator instance.
      *
-     * @param {object} options Configuration options for bearer authentication.
-     * @param {string} options.bearerToken The bearer token to be added
-     *   to requests.
-     * @throws {Error} The configuration bearerToken is not valid, or unspecified.
+     * @param options - Configuration options for bearer authentication.
+     * This should be an object containing the "bearerToken" field.
+     *
+     * @throws Error: the options.bearerToken field is not valid, or unspecified
      */
     constructor(options: Options);
     /**
      * Set a new bearer token to be sent in subsequent requests.
      *
-     * @param {string} bearerToken The bearer token that will be sent in service
+     * @param bearerToken - The bearer token that will be sent in service
      *   requests.
      */
     setBearerToken(bearerToken: string): void;
     /**
-     * Add a bearer token to the `request`. The bearer token information
-     * will be set in the Authorization property of`request.headers` in the form:
+     * Add a bearer token to `requestOptions`. The bearer token information
+     * will be set in the Authorization property of "requestOptions.headers" in the form:
      *
-     *      Authorization: Bearer <bearer-token>
+     *      Authorization: Bearer \<bearer-token\>
      *
-     * @param {object} requestOptions - The request to augment with authentication
-     *   information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added to.
+     * @param requestOptions - The request to augment with authentication information.
      */
     authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**

package/es/auth/authenticators/bearer-token-authenticator.js

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,16 +22,16 @@ import { Authenticator } from './authenticator';
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export class BearerTokenAuthenticator extends Authenticator {
     /**
      * Create a new BearerTokenAuthenticator instance.
      *
-     * @param {object} options Configuration options for bearer authentication.
-     * @param {string} options.bearerToken The bearer token to be added
-     *   to requests.
-     * @throws {Error} The configuration bearerToken is not valid, or unspecified.
+     * @param options - Configuration options for bearer authentication.
+     * This should be an object containing the "bearerToken" field.
+     *
+     * @throws Error: the options.bearerToken field is not valid, or unspecified
      */
     constructor(options) {
         super();
@@ -42,22 +42,19 @@ export class BearerTokenAuthenticator extends Authenticator {
     /**
      * Set a new bearer token to be sent in subsequent requests.
      *
-     * @param {string} bearerToken The bearer token that will be sent in service
+     * @param bearerToken - The bearer token that will be sent in service
      *   requests.
      */
     setBearerToken(bearerToken) {
         this.bearerToken = bearerToken;
     }
     /**
-     * Add a bearer token to the `request`. The bearer token information
-     * will be set in the Authorization property of`request.headers` in the form:
+     * Add a bearer token to `requestOptions`. The bearer token information
+     * will be set in the Authorization property of "requestOptions.headers" in the form:
      *
-     *      Authorization: Bearer <bearer-token>
+     *      Authorization: Bearer \<bearer-token\>
      *
-     * @param {object} requestOptions - The request to augment with authentication
-     *   information.
-     * @param {object.<string, string>} requestOptions.headers - The headers the
-     *   authentication information will be added to.
+     * @param requestOptions - The request to augment with authentication information.
      */
     authenticate(requestOptions) {
         return new Promise((resolve) => {

package/es/auth/authenticators/cloud-pak-for-data-authenticator.d.ts

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,12 +27,12 @@ export interface Options extends BaseOptions {
     url: string;
 }
 /**
- * The [[CloudPakForDataAuthenticator]] will either use a username/password pair or a username/apikey pair to obtain
+ * The CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain
  * a bearer token from a token server.  When the bearer token expires, a new token is obtained from the token server.
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator {
     protected requiredOptions: string[];
@@ -41,19 +41,19 @@ export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthe
     private password;
     private apikey;
     /**
-     * Create a new [[CloudPakForDataAuthenticator]] instance.
+     * Create a new CloudPakForDataAuthenticator instance.
      *
-     * @param {object} options Configuration options for CloudPakForData authentication.
-     * @param {string} options.url For HTTP token requests.
-     * @param {string} options.username The username used to obtain a bearer token.
-     * @param {string} [options.password] The password used to obtain a bearer token [required if apikey not specified].
-     * @param {string} [options.apikey] The API key used to obtain a bearer token [required if password not specified].
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {object<string, string>} [options.headers] to be sent with every.
-     * @throws `Error` The username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token
-     *   requests.
+     * @param options - Configuration options for CloudPakForData authentication.
+     * This should be an object containing these fields:
+     * - url: (required) the endpoint URL for the CloudPakForData token service
+     * - username: (required) the username used to obtain a bearer token
+     * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
+     * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     *
+     * @throws Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.
      */
     constructor(options: Options);
     /**

package/es/auth/authenticators/cloud-pak-for-data-authenticator.js

@@ -1,5 +1,5 @@
 /**
- * (C) Copyright IBM Corp. 2019, 2021.
+ * (C) Copyright IBM Corp. 2019, 2022.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,28 +17,28 @@ import { Authenticator } from './authenticator';
 import { Cp4dTokenManager } from '../token-managers';
 import { TokenRequestBasedAuthenticator } from './token-request-based-authenticator';
 /**
- * The [[CloudPakForDataAuthenticator]] will either use a username/password pair or a username/apikey pair to obtain
+ * The CloudPakForDataAuthenticator will either use a username/password pair or a username/apikey pair to obtain
  * a bearer token from a token server.  When the bearer token expires, a new token is obtained from the token server.
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator {
     /**
-     * Create a new [[CloudPakForDataAuthenticator]] instance.
+     * Create a new CloudPakForDataAuthenticator instance.
      *
-     * @param {object} options Configuration options for CloudPakForData authentication.
-     * @param {string} options.url For HTTP token requests.
-     * @param {string} options.username The username used to obtain a bearer token.
-     * @param {string} [options.password] The password used to obtain a bearer token [required if apikey not specified].
-     * @param {string} [options.apikey] The API key used to obtain a bearer token [required if password not specified].
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {object<string, string>} [options.headers] to be sent with every.
-     * @throws `Error` The username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token
-     *   requests.
+     * @param options - Configuration options for CloudPakForData authentication.
+     * This should be an object containing these fields:
+     * - url: (required) the endpoint URL for the CloudPakForData token service
+     * - username: (required) the username used to obtain a bearer token
+     * - password: (optional) the password used to obtain a bearer token (required if apikey is not specified)
+     * - apikey: (optional) the API key used to obtain a bearer token (required if password is not specified)
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     *
+     * @throws Error: the username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.
      */
     constructor(options) {
         super(options);

package/es/auth/authenticators/container-authenticator.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 IBM Corp. All Rights Reserved.
+ * Copyright 2021, 2022 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,13 +25,13 @@ export interface Options extends IamRequestOptions {
     iamProfileId?: string;
 }
 /**
- * The [[ContainerAuthenticator]] will read a compute resource token from the file system
+ * The ContainerAuthenticator will read a compute resource token from the file system
  * and use this value to obtain a bearer token from the IAM token server.  When the bearer
  * token expires, a new token is obtained from the token server.
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export declare class ContainerAuthenticator extends IamRequestBasedAuthenticator {
     protected tokenManager: ContainerTokenManager;
@@ -40,39 +40,39 @@ export declare class ContainerAuthenticator extends IamRequestBasedAuthenticator
     private iamProfileId;
     /**
      *
-     * Create a new [[ContainerAuthenticator]] instance.
+     * Create a new ContainerAuthenticator instance.
      *
-     * @param {object} options Configuration options for IAM authentication.
-     * @param {string} [options.crTokenFilename] The file containing the compute resource token.
-     * @param {string} [options.iamProfileName] The IAM profile name associated with the compute resource token.
-     * @param {string} [options.iamProfileId] The IAM profile ID associated with the compute resource token.
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {string} [options.url] for HTTP token requests.
-     * @param {object<string, string>} options.headers to be sent with every
-     * @param {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.scope] The "scope" parameter to use when fetching the bearer token from the
-     *   IAM token server.
-     * @throws {Error} When the configuration options are not valid.
+     * @param options - Configuration options for IAM authentication.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - crTokenFilename: (optional) the file containing the compute resource token
+     * - iamProfileName: (optional) the name of the IAM trusted profile associated with the compute resource token (required if iamProfileId is not specified)
+     * - iamProfileId]: (optional) the ID of the IAM trusted profile associated with the compute resource token (required if iamProfileName is not specified)
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+     *
+     * @throws Error: the configuration options are not valid.
      */
     constructor(options: Options);
     /**
      * Setter for the filename of the compute resource token.
-     * @param {string} A string containing a path to the CR token file
+     * @param crTokenFilename - A string containing a path to the CR token file
      */
     setCrTokenFilename(crTokenFilename: string): void;
     /**
      * Setter for the "profile_name" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileName parameter
+     * @param iamProfileName - the name of the IAM trusted profile
      */
     setIamProfileName(iamProfileName: string): void;
     /**
      * Setter for the "profile_id" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileId parameter
+     * @param iamProfileId - the ID of the IAM trusted profile
      */
     setIamProfileId(iamProfileId: string): void;
     /**

package/es/auth/authenticators/container-authenticator.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2021 IBM Corp. All Rights Reserved.
+ * Copyright 2021, 2022 IBM Corp. All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,35 +17,35 @@ import { Authenticator } from './authenticator';
 import { ContainerTokenManager } from '../token-managers';
 import { IamRequestBasedAuthenticator } from './iam-request-based-authenticator';
 /**
- * The [[ContainerAuthenticator]] will read a compute resource token from the file system
+ * The ContainerAuthenticator will read a compute resource token from the file system
  * and use this value to obtain a bearer token from the IAM token server.  When the bearer
  * token expires, a new token is obtained from the token server.
  *
  * The bearer token will be sent as an Authorization header in the form:
  *
- *      Authorization: Bearer <bearer-token>
+ *      Authorization: Bearer \<bearer-token\>
  */
 export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
     /**
      *
-     * Create a new [[ContainerAuthenticator]] instance.
+     * Create a new ContainerAuthenticator instance.
      *
-     * @param {object} options Configuration options for IAM authentication.
-     * @param {string} [options.crTokenFilename] The file containing the compute resource token.
-     * @param {string} [options.iamProfileName] The IAM profile name associated with the compute resource token.
-     * @param {string} [options.iamProfileId] The IAM profile ID associated with the compute resource token.
-     * @param {boolean} [options.disableSslVerification] A flag that indicates
-     *   whether verification of the token server's SSL certificate should be
-     *   disabled or not
-     * @param {string} [options.url] for HTTP token requests.
-     * @param {object<string, string>} options.headers to be sent with every
-     * @param {string} [options.clientId] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.clientSecret] The `clientId` and `clientSecret` fields are used to form a "basic"
-     *   authorization header for IAM token requests.
-     * @param {string} [options.scope] The "scope" parameter to use when fetching the bearer token from the
-     *   IAM token server.
-     * @throws {Error} When the configuration options are not valid.
+     * @param options - Configuration options for IAM authentication.
+     * This should be an object containing these fields:
+     * - url: (optional) the endpoint URL for the token service
+     * - crTokenFilename: (optional) the file containing the compute resource token
+     * - iamProfileName: (optional) the name of the IAM trusted profile associated with the compute resource token (required if iamProfileId is not specified)
+     * - iamProfileId]: (optional) the ID of the IAM trusted profile associated with the compute resource token (required if iamProfileName is not specified)
+     * - disableSslVerification: (optional) a flag that indicates whether verification of the token server's SSL certificate
+     * should be disabled or not
+     * - headers: (optional) a set of HTTP headers to be sent with each request to the token service
+     * - clientId: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - clientSecret: (optional) the "clientId" and "clientSecret" fields are used to form a Basic
+     * Authorization header to be included in each request to the token service
+     * - scope: (optional) the "scope" parameter to use when fetching the bearer token from the token service
+     *
+     * @throws Error: the configuration options are not valid.
      */
     constructor(options) {
         super(options);
@@ -59,7 +59,7 @@ export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
     }
     /**
      * Setter for the filename of the compute resource token.
-     * @param {string} A string containing a path to the CR token file
+     * @param crTokenFilename - A string containing a path to the CR token file
      */
     setCrTokenFilename(crTokenFilename) {
         this.crTokenFilename = crTokenFilename;
@@ -68,7 +68,7 @@ export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
     }
     /**
      * Setter for the "profile_name" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileName parameter
+     * @param iamProfileName - the name of the IAM trusted profile
      */
     setIamProfileName(iamProfileName) {
         this.iamProfileName = iamProfileName;
@@ -77,7 +77,7 @@ export class ContainerAuthenticator extends IamRequestBasedAuthenticator {
     }
     /**
      * Setter for the "profile_id" parameter to use when fetching the bearer token from the IAM token server.
-     * @param {string} A string that makes up the iamProfileId parameter
+     * @param iamProfileId - the ID of the IAM trusted profile
      */
     setIamProfileId(iamProfileId) {
         this.iamProfileId = iamProfileId;