Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FusionApplicationsClient

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

  • FusionApplicationsClient

Constructors

constructor

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

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 = "FusionApplications"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

changeFusionEnvironmentCompartment

  • Moves a FusionEnvironment into a different compartment. 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 ChangeFusionEnvironmentCompartment API.

    Parameters

    Returns Promise<ChangeFusionEnvironmentCompartmentResponse>

    ChangeFusionEnvironmentCompartmentResponse

changeFusionEnvironmentFamilyCompartment

close

  • close(): void

createDataMaskingActivity

createFusionEnvironment

createFusionEnvironmentAdminUser

createFusionEnvironmentFamily

createRefreshActivity

createServiceAttachment

createWaiters

deleteFusionEnvironment

deleteFusionEnvironmentAdminUser

deleteFusionEnvironmentFamily

deleteRefreshActivity

  • Deletes a scheduled RefreshActivity 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 DeleteRefreshActivity API.

    Parameters

    Returns Promise<DeleteRefreshActivityResponse>

    DeleteRefreshActivityResponse

deleteServiceAttachment

generateExtractDetails

  • Begin the process of showing the details about where to retrieve data extract for a Fusion environment.

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

    Parameters

    Returns Promise<GenerateExtractDetailsResponse>

    GenerateExtractDetailsResponse

getDataMaskingActivity

getFusionEnvironment

getFusionEnvironmentFamily

getFusionEnvironmentFamilyLimitsAndUsage

  • Gets the number of environments (usage) of each type in the fusion environment family, as well as the limit that's allowed to be created based on the group's associated subscriptions. 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 GetFusionEnvironmentFamilyLimitsAndUsage API.

    Parameters

    Returns Promise<GetFusionEnvironmentFamilyLimitsAndUsageResponse>

    GetFusionEnvironmentFamilyLimitsAndUsageResponse

getFusionEnvironmentFamilySubscriptionDetail

getFusionEnvironmentStatus

getRefreshActivity

getScheduledActivity

getServiceAttachment

getWaiters

getWorkRequest

  • Gets the status of the work request with the given ID. 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 GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

initiateExtract

  • Begin the process of generating the data extract for a Fusion environment.

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

    Parameters

    Returns Promise<InitiateExtractResponse>

    InitiateExtractResponse

listAdminUsers

  • List all FusionEnvironment admin users 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 ListAdminUsers API.

    Parameters

    Returns Promise<ListAdminUsersResponse>

    ListAdminUsersResponse

listDataMaskingActivities

listFusionEnvironmentFamilies

listFusionEnvironments

listRefreshActivities

listScheduledActivities

listServiceAttachments

listTimeAvailableForRefreshes

listWorkRequestErrors

  • Return a (paginated) list of errors for a given work request.

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

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

  • Return a (paginated) list of logs for a given work request.

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

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

  • Lists the work requests in a compartment.

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

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

resetFusionEnvironmentPassword

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateFusionEnvironment

updateFusionEnvironmentFamily

updateRefreshActivity

verifyServiceAttachment

  • Verify whether a service instance can be attached to the fusion pod

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

    Parameters

    Returns Promise<VerifyServiceAttachmentResponse>

    VerifyServiceAttachmentResponse