Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FleetAppsManagementClient

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

  • FleetAppsManagementClient

Constructors

constructor

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

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

targetService

targetService: string = "FleetAppsManagement"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://fams.{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

checkResourceTagging

close

  • close(): void

confirmTargets

  • Confirm targets to be managed for a Fleet.Only targets that are confirmed will be managed by FAMS

    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 ConfirmTargets API.

    Parameters

    Returns Promise<ConfirmTargetsResponse>

    ConfirmTargetsResponse

createFleet

  • Creates a new fleet instance that includes fleet resources and properties. For more information, please see the documentation.

    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 CreateFleet API.

    Parameters

    Returns Promise<CreateFleetResponse>

    CreateFleetResponse

createFleetCredential

createFleetProperty

createFleetResource

createWaiters

deleteFleet

deleteFleetCredential

deleteFleetProperty

deleteFleetResource

generateComplianceReport

getComplianceReport

getFleet

getFleetCredential

getFleetProperty

getFleetResource

getWaiters

getWorkRequest

listAnnouncements

listFleetCredentials

listFleetProducts

listFleetProperties

listFleetResources

listFleetTargets

listFleets

  • Returns a list of Fleets in the specified Tenancy.

    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 ListFleets API.

    Parameters

    Returns Promise<ListFleetsResponse>

    ListFleetsResponse

listInventoryResources

listTargets

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

requestResourceValidation

requestTargetDiscovery

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateFleet

updateFleetCredential

updateFleetProperty

updateFleetResource