ibm-cloud-sdk-core 5.1.0 → 5.1.2

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

@@ -0,0 +1,53 @@
+<!-- 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
+
+Sets the ID of the IAM trusted profile to use when obtaining an access token from the IAM token server.
+
+**Signature:**
+
+```typescript
+setIamProfileId(iamProfileId: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+iamProfileId
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the ID of the IAM trusted profile
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

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

@@ -0,0 +1,53 @@
+<!-- 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
+
+Sets the name of the IAM trusted profile to use when obtaining an access token from the IAM token server.
+
+**Signature:**
+
+```typescript
+setIamProfileName(iamProfileName: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+iamProfileName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the name of the IAM trusted profile
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+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
+
+**Signature:**
+
+```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,54 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+Options
+
+
+</td><td>
+
+Configuration options 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
+
+
+</td></tr>
+</tbody></table>
+
+## Exceptions
+
+Error: the configuration options were invalid.
+

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

@@ -0,0 +1,128 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+export declare class Cp4dTokenManager extends JwtTokenManager 
+```
+**Extends:** [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new Cp4dTokenManager instance.
+
+
+</td></tr>
+</tbody></table>
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[requiredOptions](./ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[requestToken()](./ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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
+
+**Signature:**
+
+```typescript
+protected requestToken(): Promise<any>;
+```
+**Returns:**
+
+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
+
+**Signature:**
+
+```typescript
+protected requiredOptions: string[];
+```

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

@@ -0,0 +1,49 @@
+<!-- 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
+
+**Signature:**
+
+```typescript
+export declare function fileExistsAtPath(filepath: string): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+filepath
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+

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

@@ -0,0 +1,80 @@
+<!-- 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, 2023.
+
+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.
+
+**Signature:**
+
+```typescript
+export interface FileObject 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[options?](./ibm-cloud-sdk-core.fileobject.options.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[FileOptions](./ibm-cloud-sdk-core.fileoptions.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[value](./ibm-cloud-sdk-core.fileobject.value.md)
+
+
+</td><td>
+
+
+</td><td>
+
+NodeJS.ReadableStream \| Buffer \| string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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
+
+**Signature:**
+
+```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
+
+**Signature:**
+
+```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
+
+**Signature:**
+
+```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
+
+**Signature:**
+
+```typescript
+filename?: string;
+```

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

@@ -0,0 +1,74 @@
+<!-- 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
+
+**Signature:**
+
+```typescript
+export interface FileOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[contentType?](./ibm-cloud-sdk-core.fileoptions.contenttype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[filename?](./ibm-cloud-sdk-core.fileoptions.filename.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>

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

@@ -0,0 +1,54 @@
+<!-- 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
+
+**Signature:**
+
+```typescript
+export interface FileStream extends NodeJS.ReadableStream 
+```
+**Extends:** NodeJS.ReadableStream
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[path](./ibm-cloud-sdk-core.filestream.path.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| Buffer
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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
+
+**Signature:**
+
+```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
+
+**Signature:**
+
+```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
+
+**Signature:**
+
+```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
+
+**Signature:**
+
+```typescript
+filename: string;
+```