ibm-cloud-sdk-core 4.3.2-beta-2 → 4.3.3

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

@@ -0,0 +1,171 @@
+<!-- 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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md)
+
+## UserOptions interface
+
+Configuration values for a service.
+
+**Signature:**
+
+```typescript
+export interface UserOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticator?](./ibm-cloud-sdk-core.useroptions.authenticator.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)
+
+
+</td><td>
+
+_(Optional)_ The Authenticator object used to authenticate requests to the service
+
+
+</td></tr>
+<tr><td>
+
+[disableSslVerification?](./ibm-cloud-sdk-core.useroptions.disablesslverification.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Set to `true` to allow unauthorized requests - not recommended for production use.
+
+
+</td></tr>
+<tr><td>
+
+[headers?](./ibm-cloud-sdk-core.useroptions.headers.md)
+
+
+</td><td>
+
+
+</td><td>
+
+OutgoingHttpHeaders
+
+
+</td><td>
+
+_(Optional)_ Default headers that shall be included with every request to the service.
+
+
+</td></tr>
+<tr><td>
+
+[jar?](./ibm-cloud-sdk-core.useroptions.jar.md)
+
+
+</td><td>
+
+
+</td><td>
+
+CookieJar \| boolean
+
+
+</td><td>
+
+_(Optional)_ Set your own cookie jar object
+
+
+</td></tr>
+<tr><td>
+
+[serviceUrl?](./ibm-cloud-sdk-core.useroptions.serviceurl.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
+
+
+</td></tr>
+<tr><td>
+
+[url?](./ibm-cloud-sdk-core.useroptions.url.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ Deprecated. Use `serviceUrl` instead.
+
+
+</td></tr>
+<tr><td>
+
+[version?](./ibm-cloud-sdk-core.useroptions.version.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The API version date to use with the service, in "YYYY-MM-DD" format.
+
+
+</td></tr>
+</tbody></table>

package/build/docs/ibm-cloud-sdk-core.useroptions.serviceurl.md

@@ -0,0 +1,13 @@
+<!-- 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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [serviceUrl](./ibm-cloud-sdk-core.useroptions.serviceurl.md)
+
+## UserOptions.serviceUrl property
+
+The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
+
+**Signature:**
+
+```typescript
+serviceUrl?: string;
+```

package/build/docs/ibm-cloud-sdk-core.useroptions.url.md

@@ -0,0 +1,13 @@
+<!-- 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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [url](./ibm-cloud-sdk-core.useroptions.url.md)
+
+## UserOptions.url property
+
+Deprecated. Use `serviceUrl` instead.
+
+**Signature:**
+
+```typescript
+url?: string;
+```

package/build/docs/ibm-cloud-sdk-core.useroptions.version.md

@@ -0,0 +1,13 @@
+<!-- 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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [version](./ibm-cloud-sdk-core.useroptions.version.md)
+
+## UserOptions.version property
+
+The API version date to use with the service, in "YYYY-MM-DD" format.
+
+**Signature:**
+
+```typescript
+version?: string;
+```

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

@@ -0,0 +1,73 @@
+<!-- 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; [validateInput](./ibm-cloud-sdk-core.validateinput.md)
+
+## validateInput() function
+
+Validates "options".
+
+**Signature:**
+
+```typescript
+export declare function validateInput(options: any, requiredOptions: string[]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+a configuration options object
+
+
+</td></tr>
+<tr><td>
+
+requiredOptions
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+the list of properties that must be present in "options"
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+
+## Exceptions
+
+Error: "options" failed validation
+

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

@@ -0,0 +1,89 @@
+<!-- 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; [validateParams](./ibm-cloud-sdk-core.validateparams.md)
+
+## validateParams() function
+
+Validates that "params" contains a value for each key listed in "requiredParams", and that each key contained in "params" is a valid key listed in "allParams". In essence, we want params to contain only valid keys and we want params to contain at least the required keys.
+
+**Signature:**
+
+```typescript
+export declare function validateParams(params: {
+    [key: string]: any;
+}, requiredParams: string[], allParams: string[]): null | Error;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+params
+
+
+</td><td>
+
+{ \[key: string\]: any; }
+
+
+</td><td>
+
+the "params" object passed into an operation containing method parameters.
+
+
+</td></tr>
+<tr><td>
+
+requiredParams
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+the names of required parameters. If null, then the "required params" check is bypassed.
+
+
+</td></tr>
+<tr><td>
+
+allParams
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+the names of all valid parameters. If null, then the "valid params" check is bypassed.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+null \| Error
+
+null if no errors found, otherwise an Error instance
+

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator._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; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md)
+
+## VpcInstanceAuthenticator.(constructor)
+
+Create a new VpcInstanceAuthenticator 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 for VpcInstance authentication. 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.vpcinstanceauthenticator.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; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md)
+
+## VpcInstanceAuthenticator.authenticationType() method
+
+Returns the authenticator's type ('vpc').
+
+**Signature:**
+
+```typescript
+authenticationType(): string;
+```
+**Returns:**
+
+string
+
+a string that indicates the authenticator's type
+

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

@@ -0,0 +1,158 @@
+<!-- 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)
+
+## VpcInstanceAuthenticator class
+
+The VpcInstanceAuthenticator implements an authentication scheme in which it retrieves an "instance identity token" and exchanges that for an IAM access token using the VPC Instance Metadata Service API which is available on the local compute resource (VM). The instance identity token is similar to an IAM apikey, except that it is managed automatically by the compute resource provider (VPC).
+
+The resulting IAM access token is then added to outbound requests in an Authorization header
+
+Authorization: Bearer &lt;<!-- -->access-token<!-- -->&gt;
+
+**Signature:**
+
+```typescript
+export declare class VpcInstanceAuthenticator extends TokenRequestBasedAuthenticator 
+```
+**Extends:** [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.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.vpcinstanceauthenticator._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new VpcInstanceAuthenticator 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>
+
+[tokenManager](./ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+[VpcInstanceTokenManager](./ibm-cloud-sdk-core.vpcinstancetokenmanager.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticationType()](./ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Returns the authenticator's type ('vpc').
+
+
+</td></tr>
+<tr><td>
+
+[setIamProfileCrn(iamProfileCrn)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the "iamProfileCrn" value to be used when obtaining an IAM access token
+
+
+</td></tr>
+<tr><td>
+
+[setIamProfileId(iamProfileId)](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the "iamProfileId" value to be used when obtaining an IAM access token
+
+
+</td></tr>
+</tbody></table>

package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.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; [VpcInstanceAuthenticator](./ibm-cloud-sdk-core.vpcinstanceauthenticator.md) &gt; [setIamProfileCrn](./ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md)
+
+## VpcInstanceAuthenticator.setIamProfileCrn() method
+
+Sets the "iamProfileCrn" value to be used when obtaining an IAM access token
+
+**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 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.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; [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
+