ibm-cloud-sdk-core 3.2.2-beta-5 → 4.0.0

package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.md

@@ -0,0 +1,39 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md)
+
+## BearerTokenAuthenticator class
+
+The BearerTokenAuthenticator will set a user-provided bearer token in requests.
+
+The bearer token will be sent as an Authorization header in the form:
+
+Authorization: Bearer <bearer-token>
+
+<b>Signature:</b>
+
+```typescript
+export declare class BearerTokenAuthenticator extends Authenticator 
+```
+<b>Extends:</b> [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md) |  | Create a new BearerTokenAuthenticator instance. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [requiredOptions](./ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md) |  | string\[\] |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md) |  | Add a bearer token to the <code>request</code>. The bearer token information will be set in the Authorization property of<code>request.headers</code> in the form:<!-- -->Authorization: Bearer <bearer-token> |
+|  [authenticationType()](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('bearertoken'). |
+|  [setBearerToken(bearerToken)](./ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.md) |  | Set a new bearer token to be sent in subsequent requests. |
+

package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md) &gt; [requiredOptions](./ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md)
+
+## BearerTokenAuthenticator.requiredOptions property
+
+<b>Signature:</b>
+
+```typescript
+protected requiredOptions: string[];
+```

package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md) &gt; [setBearerToken](./ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.md)
+
+## BearerTokenAuthenticator.setBearerToken() method
+
+Set a new bearer token to be sent in subsequent requests.
+
+<b>Signature:</b>
+
+```typescript
+setBearerToken(bearerToken: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  bearerToken | string | The bearer token that will be sent in service requests. |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.buildrequestfileobject.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [buildRequestFileObject](./ibm-cloud-sdk-core.buildrequestfileobject.md)
+
+## buildRequestFileObject() function
+
+This function builds a `form-data` object for each file parameter.
+
+<b>Signature:</b>
+
+```typescript
+export declare function buildRequestFileObject(fileParam: FileWithMetadata): Promise<FileObject>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fileParam | [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) | The file parameter. |
+
+<b>Returns:</b>
+
+Promise&lt;[FileObject](./ibm-cloud-sdk-core.fileobject.md)<!-- -->&gt;
+
+{<!-- -->FileObject<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.checkcredentials.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [checkCredentials](./ibm-cloud-sdk-core.checkcredentials.md)
+
+## checkCredentials() function
+
+Checks credentials for common user mistakes of copying {<!-- -->, }<!-- -->, or " characters from the documentation
+
+<b>Signature:</b>
+
+```typescript
+export declare function checkCredentials(obj: any, credsToCheck: string[]): Error | null;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  obj | any | The options object holding credentials |
+|  credsToCheck | string\[\] | An array containing the keys of the credentials to check for problems |
+
+<b>Returns:</b>
+
+Error \| null
+
+{<!-- -->string \| null<!-- -->} - Returns a string with the error message if there were problems, null if not
+

package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md)
+
+## CloudPakForDataAuthenticator.(constructor)
+
+Create a new \[\[CloudPakForDataAuthenticator\]\] instance.
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | Options | Configuration options for CloudPakForData authentication. |
+
+## Exceptions
+
+`Error` The username, password, and/or url are not valid, or unspecified, for Cloud Pak For Data token requests.
+

package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md)
+
+## CloudPakForDataAuthenticator.authenticationType() method
+
+Returns the authenticator's type ('cp4d').
+
+<b>Signature:</b>
+
+```typescript
+authenticationType(): string;
+```
+<b>Returns:</b>
+
+string
+
+a string that indicates the authenticator's type
+

package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.md

@@ -0,0 +1,38 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md)
+
+## CloudPakForDataAuthenticator class
+
+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>
+
+<b>Signature:</b>
+
+```typescript
+export declare class CloudPakForDataAuthenticator extends TokenRequestBasedAuthenticator 
+```
+<b>Extends:</b> [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md) |  | Create a new \[\[CloudPakForDataAuthenticator\]\] instance. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [requiredOptions](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md) |  | string\[\] |  |
+|  [tokenManager](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md) |  | [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [authenticationType()](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('cp4d'). |
+

package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) &gt; [requiredOptions](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md)
+
+## CloudPakForDataAuthenticator.requiredOptions property
+
+<b>Signature:</b>
+
+```typescript
+protected requiredOptions: string[];
+```

package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [CloudPakForDataAuthenticator](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md)
+
+## CloudPakForDataAuthenticator.tokenManager property
+
+<b>Signature:</b>
+
+```typescript
+protected tokenManager: Cp4dTokenManager;
+```

package/build/docs/ibm-cloud-sdk-core.computebasicauthheader.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [computeBasicAuthHeader](./ibm-cloud-sdk-core.computebasicauthheader.md)
+
+## computeBasicAuthHeader() function
+
+Compute and return a Basic Authorization header from a username and password.
+
+<b>Signature:</b>
+
+```typescript
+export declare function computeBasicAuthHeader(username: string, password: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  username | string | The username or client id |
+|  password | string | The password or client secret |
+
+<b>Returns:</b>
+
+string
+
+{<!-- -->string<!-- -->} - A Basic Auth header with format "Basic <encoded-credentials>"
+

package/build/docs/ibm-cloud-sdk-core.constructfilepath.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [constructFilepath](./ibm-cloud-sdk-core.constructfilepath.md)
+
+## constructFilepath() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function constructFilepath(filepath: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  filepath | string |  |
+
+<b>Returns:</b>
+
+string
+

package/build/docs/ibm-cloud-sdk-core.constructserviceurl.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [constructServiceUrl](./ibm-cloud-sdk-core.constructserviceurl.md)
+
+## constructServiceUrl() function
+
+Constructs a service URL by formatting a parameterized URL.
+
+<b>Signature:</b>
+
+```typescript
+export declare function constructServiceUrl(parameterizedUrl: string, defaultUrlVariables: Map<string, string>, providedUrlVariables: Map<string, string> | null): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  parameterizedUrl | string | URL that contains variable placeholders, e.g. '<!-- -->{<!-- -->scheme<!-- -->}<!-- -->://ibm.com'. |
+|  defaultUrlVariables | Map&lt;string, string&gt; | Map from variable names to default values. Each variable in the parameterized URL must have a default value specified in this map. |
+|  providedUrlVariables | Map&lt;string, string&gt; \| null | Map from variable names to desired values. If a variable is not provided in this map, the default variable value will be used instead. |
+
+<b>Returns:</b>
+
+string
+
+{<!-- -->string<!-- -->} The formatted URL with all variable placeholders replaced by values.
+

package/build/docs/ibm-cloud-sdk-core.containerauthenticator._constructor_.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.containerauthenticator._constructor_.md)
+
+## ContainerAuthenticator.(constructor)
+
+Create a new \[\[ContainerAuthenticator\]\] instance.
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | Options | Configuration options for IAM authentication. |
+
+## Exceptions
+
+{<!-- -->Error<!-- -->} When the configuration options are not valid.
+

package/build/docs/ibm-cloud-sdk-core.containerauthenticator.authenticationtype.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.containerauthenticator.authenticationtype.md)
+
+## ContainerAuthenticator.authenticationType() method
+
+Returns the authenticator's type ('container').
+
+<b>Signature:</b>
+
+```typescript
+authenticationType(): string;
+```
+<b>Returns:</b>
+
+string
+
+a string that indicates the authenticator's type
+

package/build/docs/ibm-cloud-sdk-core.containerauthenticator.md

@@ -0,0 +1,40 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md)
+
+## ContainerAuthenticator class
+
+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>
+
+<b>Signature:</b>
+
+```typescript
+export declare class ContainerAuthenticator extends IamRequestBasedAuthenticator 
+```
+<b>Extends:</b> [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.containerauthenticator._constructor_.md) |  | Create a new \[\[ContainerAuthenticator\]\] instance. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [tokenManager](./ibm-cloud-sdk-core.containerauthenticator.tokenmanager.md) |  | [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [authenticationType()](./ibm-cloud-sdk-core.containerauthenticator.authenticationtype.md) |  | Returns the authenticator's type ('container'). |
+|  [setCrTokenFilename(crTokenFilename)](./ibm-cloud-sdk-core.containerauthenticator.setcrtokenfilename.md) |  | Setter for the filename of the compute resource token. |
+|  [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.containerauthenticator.setiamprofileid.md) |  | Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server. |
+|  [setIamProfileName(iamProfileName)](./ibm-cloud-sdk-core.containerauthenticator.setiamprofilename.md) |  | Setter for the "profile\_name" parameter to use when fetching the bearer token from the IAM token server. |
+

package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setcrtokenfilename.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) &gt; [setCrTokenFilename](./ibm-cloud-sdk-core.containerauthenticator.setcrtokenfilename.md)
+
+## ContainerAuthenticator.setCrTokenFilename() method
+
+Setter for the filename of the compute resource token.
+
+<b>Signature:</b>
+
+```typescript
+setCrTokenFilename(crTokenFilename: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  crTokenFilename | string |  |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofileid.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) &gt; [setIamProfileId](./ibm-cloud-sdk-core.containerauthenticator.setiamprofileid.md)
+
+## ContainerAuthenticator.setIamProfileId() method
+
+Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server.
+
+<b>Signature:</b>
+
+```typescript
+setIamProfileId(iamProfileId: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  iamProfileId | string |  |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofilename.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) &gt; [setIamProfileName](./ibm-cloud-sdk-core.containerauthenticator.setiamprofilename.md)
+
+## ContainerAuthenticator.setIamProfileName() method
+
+Setter for the "profile\_name" parameter to use when fetching the bearer token from the IAM token server.
+
+<b>Signature:</b>
+
+```typescript
+setIamProfileName(iamProfileName: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  iamProfileName | string |  |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.containerauthenticator.tokenmanager.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerAuthenticator](./ibm-cloud-sdk-core.containerauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.containerauthenticator.tokenmanager.md)
+
+## ContainerAuthenticator.tokenManager property
+
+<b>Signature:</b>
+
+```typescript
+protected tokenManager: ContainerTokenManager;
+```

package/build/docs/ibm-cloud-sdk-core.containertokenmanager._constructor_.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.containertokenmanager._constructor_.md)
+
+## ContainerTokenManager.(constructor)
+
+Create a new \[\[ContainerTokenManager\]\] instance.
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | Options | Configuration options. |
+

package/build/docs/ibm-cloud-sdk-core.containertokenmanager.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md)
+
+## ContainerTokenManager class
+
+The ContainerTokenManager retrieves a compute resource token from a file on the container. This token is used to perform the necessary interactions with the IAM token service to obtain and store a suitable bearer (access) token.
+
+<b>Signature:</b>
+
+```typescript
+export declare class ContainerTokenManager extends IamRequestBasedTokenManager 
+```
+<b>Extends:</b> [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.containertokenmanager._constructor_.md) |  | Create a new \[\[ContainerTokenManager\]\] instance. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [requestToken()](./ibm-cloud-sdk-core.containertokenmanager.requesttoken.md) |  | Request an IAM token using a compute resource token. |
+|  [setCrTokenFilename(crTokenFilename)](./ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md) |  | Setter for the filename of the compute resource token. |
+|  [setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md) |  | Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server. |
+|  [setIamProfileName(iamProfileName)](./ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md) |  | Setter for the "profile\_name" parameter to use when fetching the bearer token from the IAM token server. |
+

package/build/docs/ibm-cloud-sdk-core.containertokenmanager.requesttoken.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) &gt; [requestToken](./ibm-cloud-sdk-core.containertokenmanager.requesttoken.md)
+
+## ContainerTokenManager.requestToken() method
+
+Request an IAM token using a compute resource token.
+
+<b>Signature:</b>
+
+```typescript
+protected requestToken(): Promise<any>;
+```
+<b>Returns:</b>
+
+Promise&lt;any&gt;
+
+{<!-- -->Promise<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) &gt; [setCrTokenFilename](./ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md)
+
+## ContainerTokenManager.setCrTokenFilename() method
+
+Setter for the filename of the compute resource token.
+
+<b>Signature:</b>
+
+```typescript
+setCrTokenFilename(crTokenFilename: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  crTokenFilename | string | A string containing a path to the CR token file |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) &gt; [setIamProfileId](./ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md)
+
+## ContainerTokenManager.setIamProfileId() method
+
+Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server.
+
+<b>Signature:</b>
+
+```typescript
+setIamProfileId(iamProfileId: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  iamProfileId | string | A string that makes up the iamProfileId parameter |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [ContainerTokenManager](./ibm-cloud-sdk-core.containertokenmanager.md) &gt; [setIamProfileName](./ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md)
+
+## ContainerTokenManager.setIamProfileName() method
+
+Setter for the "profile\_name" parameter to use when fetching the bearer token from the IAM token server.
+
+<b>Signature:</b>
+
+```typescript
+setIamProfileName(iamProfileName: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  iamProfileName | string | A string that makes up the iamProfileName parameter |
+
+<b>Returns:</b>
+
+void
+