npm - ibm-cloud-sdk-core - Versions diffs - 4.3.0 → 4.3.2-beta - Mend

ibm-cloud-sdk-core 4.3.0 → 4.3.2-beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (250) hide show

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

@@ -1,142 +0,0 @@
-<!-- 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.
-**Signature:**
-```typescript
-export declare class ContainerTokenManager extends IamRequestBasedTokenManager
-```
-**Extends:** [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.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.containertokenmanager._constructor_.md)
-</td><td>
-</td><td>
-Create a new ContainerTokenManager instance.
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[getCrToken()](./ibm-cloud-sdk-core.containertokenmanager.getcrtoken.md)
-</td><td>
-`protected`
-</td><td>
-Retrieves the CR token from a file using this search order: 1. User-specified filename (if specified) 2. Default file \#1 (/var/run/secrets/tokens/vault-token) 3. Default file \#2 (/var/run/secrets/tokens/sa-token) First one found wins.
-</td></tr>
-<tr><td>
-[requestToken()](./ibm-cloud-sdk-core.containertokenmanager.requesttoken.md)
-</td><td>
-`protected`
-</td><td>
-Request an IAM token using a compute resource token.
-</td></tr>
-<tr><td>
-[setCrTokenFilename(crTokenFilename)](./ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md)
-</td><td>
-</td><td>
-Sets the "crTokenFilename" field
-</td></tr>
-<tr><td>
-[setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md)
-</td><td>
-</td><td>
-Sets the ID of the IAM trusted profile to use when obtaining an access token from the IAM token server.
-</td></tr>
-<tr><td>
-[setIamProfileName(iamProfileName)](./ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md)
-</td><td>
-</td><td>
-Sets the name of the IAM trusted profile to use when obtaining an access token from the IAM token server.
-</td></tr>
-</tbody></table>

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

@@ -1,17 +0,0 @@
-<!-- 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.
-**Signature:**
-```typescript
-protected requestToken(): Promise<any>;
-```
-**Returns:**
-Promise&lt;any&gt;

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

@@ -1,53 +0,0 @@
-<!-- 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
-Sets the "crTokenFilename" field
-**Signature:**
-```typescript
-setCrTokenFilename(crTokenFilename: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-crTokenFilename
-</td><td>
-string
-</td><td>
-the name of the file containing the CR token
-</td></tr>
-</tbody></table>
-**Returns:**
-void

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

@@ -1,53 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,54 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,128 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,49 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,80 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- 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 DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- 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;
-```