npm - ibm-cloud-sdk-core - Versions diffs - 5.0.0 → 5.0.1 - Mend

ibm-cloud-sdk-core 5.0.0 → 5.0.1

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 (222) hide show

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.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; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [setIamProfileId](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md)
-## VpcInstanceAuthenticator.setIamProfileId() method
-Sets the "iamProfileId" value to be used when obtaining an IAM access token
-**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 linked IAM trusted profile to use when obtaining an IAM access token
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.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; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [tokenManager](./ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md)
-## VpcInstanceAuthenticator.tokenManager property
-**Signature:**
-```typescript
-protected tokenManager: VpcInstanceTokenManager;
-```

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager._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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [(constructor)](./ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md)
-## VpcInstanceTokenManager.(constructor)
-Create a new VpcInstanceTokenManager 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: (optional) the endpoint URL for the VPC Instance Metadata Service (default value: "http://169.254.169.254") - iamProfileCrn: (optional) the CRN of the linked IAM trusted profile to be used to obtain the IAM access token - iamProfileId: (optional) the ID of the linked IAM trusted profile to be used to obtain the IAM access token
-</td></tr>
-</tbody></table>
-## Remarks
-At most one of "iamProfileCrn" or "iamProfileId" may be specified. If neither one is specified, then the default IAM profile defined for the compute resource will be used.

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

@@ -1,19 +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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [isTokenExpired](./ibm-cloud-sdk-core.vpcinstancetokenmanager.istokenexpired.md)
-## VpcInstanceTokenManager.isTokenExpired() method
-Returns true iff the currently-cached IAM access token is expired. We'll consider an access token as expired when we reach its IAM server-reported expiration time minus our expiration window (10 secs). We do this to avoid using an access token that might expire in the middle of a long-running transaction within an IBM Cloud service.
-**Signature:**
-```typescript
-protected isTokenExpired(): boolean;
-```
-**Returns:**
-boolean
-true if the token has expired, false otherwise

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

@@ -1,126 +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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md)
-## VpcInstanceTokenManager class
-Token Manager for VPC Instance Authentication.
-**Signature:**
-```typescript
-export declare class VpcInstanceTokenManager 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.vpcinstancetokenmanager._constructor_.md)
-</td><td>
-</td><td>
-Create a new VpcInstanceTokenManager instance.
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[isTokenExpired()](./ibm-cloud-sdk-core.vpcinstancetokenmanager.istokenexpired.md)
-</td><td>
-`protected`
-</td><td>
-Returns true iff the currently-cached IAM access token is expired. We'll consider an access token as expired when we reach its IAM server-reported expiration time minus our expiration window (10 secs). We do this to avoid using an access token that might expire in the middle of a long-running transaction within an IBM Cloud service.
-</td></tr>
-<tr><td>
-[requestToken()](./ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md)
-</td><td>
-`protected`
-</td><td>
-</td></tr>
-<tr><td>
-[setIamProfileCrn(iamProfileCrn)](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md)
-</td><td>
-</td><td>
-Sets the CRN of the IAM trusted profile to use when fetching the access token from the IAM token server.
-</td></tr>
-<tr><td>
-[setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md)
-</td><td>
-</td><td>
-Sets the Id of the IAM trusted profile to use when fetching the access token from the IAM token server.
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [requestToken](./ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md)
-## VpcInstanceTokenManager.requestToken() method
-**Signature:**
-```typescript
-protected requestToken(): Promise<any>;
-```
-**Returns:**
-Promise&lt;any&gt;

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [setIamProfileCrn](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md)
-## VpcInstanceTokenManager.setIamProfileCrn() method
-Sets the CRN of the IAM trusted profile to use when fetching the access token from the IAM token server.
-**Signature:**
-```typescript
-setIamProfileCrn(iamProfileCrn: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-iamProfileCrn
-</td><td>
-string
-</td><td>
-the CRN of the IAM trusted profile
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.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; [VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md) &gt; [setIamProfileId](./ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md)
-## VpcInstanceTokenManager.setIamProfileId() method
-Sets the Id of the IAM trusted profile to use when fetching the 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/index.md DELETED Viewed

@@ -1,29 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md)
-## API Reference
-## Packages
-<table><thead><tr><th>
-Package
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/es/tsdoc-metadata.json DELETED Viewed

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.43.1"
-    }
-  ]
-}