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

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
+

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

@@ -0,0 +1,14 @@
+<!-- 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; [contentType](./ibm-cloud-sdk-core.contenttype.md)
+
+## contentType variable
+
+<b>Signature:</b>
+
+```typescript
+_default: {
+    fromFilename: (file: String | File | FileObject | NodeJS.ReadableStream | Buffer) => string;
+    fromHeader: (buffer: Buffer) => string;
+}
+```

package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager._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; [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md)
+
+## Cp4dTokenManager.(constructor)
+
+Create a new \[\[Cp4dTokenManager\]\] instance.
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | Options | Configuration options. |
+

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

@@ -0,0 +1,35 @@
+<!-- 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; [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md)
+
+## Cp4dTokenManager class
+
+Token Manager of CloudPak for data.
+
+The Token Manager performs basic auth with a username and password to acquire CP4D tokens.
+
+<b>Signature:</b>
+
+```typescript
+export declare class Cp4dTokenManager extends JwtTokenManager 
+```
+<b>Extends:</b> [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md) |  | Create a new \[\[Cp4dTokenManager\]\] instance. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [requiredOptions](./ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md) |  | string\[\] |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [requestToken()](./ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md) |  |  |
+

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

@@ -0,0 +1,15 @@
+<!-- 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; [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) &gt; [requestToken](./ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md)
+
+## Cp4dTokenManager.requestToken() method
+
+<b>Signature:</b>
+
+```typescript
+protected requestToken(): Promise<any>;
+```
+<b>Returns:</b>
+
+Promise&lt;any&gt;
+

package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.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; [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) &gt; [requiredOptions](./ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md)
+
+## Cp4dTokenManager.requiredOptions property
+
+<b>Signature:</b>
+
+```typescript
+protected requiredOptions: string[];
+```

package/build/docs/ibm-cloud-sdk-core.fileexistsatpath.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; [fileExistsAtPath](./ibm-cloud-sdk-core.fileexistsatpath.md)
+
+## fileExistsAtPath() function
+
+<b>Signature:</b>
+
+```typescript
+export declare function fileExistsAtPath(filepath: string): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  filepath | string |  |
+
+<b>Returns:</b>
+
+boolean
+

package/build/docs/ibm-cloud-sdk-core.fileobject.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; [FileObject](./ibm-cloud-sdk-core.fileobject.md)
+
+## FileObject interface
+
+(C) Copyright IBM Corp. 2014, 2021.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+<b>Signature:</b>
+
+```typescript
+export interface FileObject 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [options?](./ibm-cloud-sdk-core.fileobject.options.md) | [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) | <i>(Optional)</i> |
+|  [value](./ibm-cloud-sdk-core.fileobject.value.md) | NodeJS.ReadableStream \| Buffer \| string |  |
+

package/build/docs/ibm-cloud-sdk-core.fileobject.options.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; [FileObject](./ibm-cloud-sdk-core.fileobject.md) &gt; [options](./ibm-cloud-sdk-core.fileobject.options.md)
+
+## FileObject.options property
+
+<b>Signature:</b>
+
+```typescript
+options?: FileOptions;
+```

package/build/docs/ibm-cloud-sdk-core.fileobject.value.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; [FileObject](./ibm-cloud-sdk-core.fileobject.md) &gt; [value](./ibm-cloud-sdk-core.fileobject.value.md)
+
+## FileObject.value property
+
+<b>Signature:</b>
+
+```typescript
+value: NodeJS.ReadableStream | Buffer | string;
+```

package/build/docs/ibm-cloud-sdk-core.fileoptions.contenttype.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; [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) &gt; [contentType](./ibm-cloud-sdk-core.fileoptions.contenttype.md)
+
+## FileOptions.contentType property
+
+<b>Signature:</b>
+
+```typescript
+contentType?: string;
+```

package/build/docs/ibm-cloud-sdk-core.fileoptions.filename.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; [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) &gt; [filename](./ibm-cloud-sdk-core.fileoptions.filename.md)
+
+## FileOptions.filename property
+
+<b>Signature:</b>
+
+```typescript
+filename?: string;
+```

package/build/docs/ibm-cloud-sdk-core.fileoptions.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; [FileOptions](./ibm-cloud-sdk-core.fileoptions.md)
+
+## FileOptions interface
+
+<b>Signature:</b>
+
+```typescript
+export interface FileOptions 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [contentType?](./ibm-cloud-sdk-core.fileoptions.contenttype.md) | string | <i>(Optional)</i> |
+|  [filename?](./ibm-cloud-sdk-core.fileoptions.filename.md) | string | <i>(Optional)</i> |
+

package/build/docs/ibm-cloud-sdk-core.filestream.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; [FileStream](./ibm-cloud-sdk-core.filestream.md)
+
+## FileStream interface
+
+<b>Signature:</b>
+
+```typescript
+export interface FileStream extends NodeJS.ReadableStream 
+```
+<b>Extends:</b> NodeJS.ReadableStream
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [path](./ibm-cloud-sdk-core.filestream.path.md) | string \| Buffer |  |
+

package/build/docs/ibm-cloud-sdk-core.filestream.path.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; [FileStream](./ibm-cloud-sdk-core.filestream.md) &gt; [path](./ibm-cloud-sdk-core.filestream.path.md)
+
+## FileStream.path property
+
+<b>Signature:</b>
+
+```typescript
+path: string | Buffer;
+```

package/build/docs/ibm-cloud-sdk-core.filewithmetadata.contenttype.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; [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) &gt; [contentType](./ibm-cloud-sdk-core.filewithmetadata.contenttype.md)
+
+## FileWithMetadata.contentType property
+
+<b>Signature:</b>
+
+```typescript
+contentType: string;
+```

package/build/docs/ibm-cloud-sdk-core.filewithmetadata.data.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; [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) &gt; [data](./ibm-cloud-sdk-core.filewithmetadata.data.md)
+
+## FileWithMetadata.data property
+
+<b>Signature:</b>
+
+```typescript
+data: NodeJS.ReadableStream | Buffer;
+```

package/build/docs/ibm-cloud-sdk-core.filewithmetadata.filename.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; [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) &gt; [filename](./ibm-cloud-sdk-core.filewithmetadata.filename.md)
+
+## FileWithMetadata.filename property
+
+<b>Signature:</b>
+
+```typescript
+filename: string;
+```