Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InventoryClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • InventoryClient

Constructors

constructor

  • new InventoryClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): InventoryClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: InventoryWaiter

targetService

targetService: string = "Inventory"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://cloudbridge.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

analyzeAssets

  • Returns an aggregation of assets. Aggregation groups are sorted by groupBy property. Default sort order is ascending, but can be overridden by the sortOrder parameter.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AnalyzeAssets API.

    Parameters

    Returns Promise<AnalyzeAssetsResponse>

    AnalyzeAssetsResponse

changeAssetCompartment

  • Moves an asset resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeAssetCompartment API.

    Parameters

    Returns Promise<ChangeAssetCompartmentResponse>

    ChangeAssetCompartmentResponse

changeAssetTags

close

  • close(): void

createAsset

  • Creates an asset. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAsset API.

    Parameters

    Returns Promise<CreateAssetResponse>

    CreateAssetResponse

createInventory

createWaiters

  • Creates a new InventoryWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns InventoryWaiter

    The service waiters.

deleteAsset

  • Deletes an asset resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAsset API.

    Parameters

    Returns Promise<DeleteAssetResponse>

    DeleteAssetResponse

deleteInventory

  • Deletes an inventory resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteInventory API.

    Parameters

    Returns Promise<DeleteInventoryResponse>

    DeleteInventoryResponse

getAsset

  • Gets an asset by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAsset API.

    Parameters

    Returns Promise<GetAssetResponse>

    GetAssetResponse

getInventory

  • Gets an inventory by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetInventory API.

    Parameters

    Returns Promise<GetInventoryResponse>

    GetInventoryResponse

getWaiters

importInventory

listAssets

  • Returns a list of assets.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAssets API.

    Parameters

    Returns Promise<ListAssetsResponse>

    ListAssetsResponse

listHistoricalMetrics

listInventories

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

submitHistoricalMetrics

updateAsset

  • Updates the asset. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAsset API.

    Parameters

    Returns Promise<UpdateAssetResponse>

    UpdateAssetResponse

updateInventory