Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FleetSoftwareUpdateClient

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

  • FleetSoftwareUpdateClient

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

abortFsuDiscovery

addFsuCollectionTargets

  • Adds targets to an existing Exadata Fleet Update Collection. Targets that are already part of a different Collection with an active Fleet Software Update Cycle cannot be added. This operation can only be performed on Collections that do not have an Action executing under an active Fleet Software Update Cycle. Additionally, during an active Fleet Software Update Cycle, targets can be added only prior to executing an Apply Action. This will require running a new Stage Action for the active Cycle.

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

    Parameters

    Returns Promise<AddFsuCollectionTargetsResponse>

    AddFsuCollectionTargetsResponse

cancelFsuAction

  • Cancels a scheduled Action. Only applicable for Actions that have not started executing.

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

    Parameters

    Returns Promise<CancelFsuActionResponse>

    CancelFsuActionResponse

changeFsuActionCompartment

  • Moves a Exadata Fleet Update Action resource from one compartment identifier 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 ChangeFsuActionCompartment API.

    Parameters

    Returns Promise<ChangeFsuActionCompartmentResponse>

    ChangeFsuActionCompartmentResponse

changeFsuCollectionCompartment

  • Moves a Exadata Fleet Update Collection resource from one compartment identifier 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 ChangeFsuCollectionCompartment API.

    Parameters

    Returns Promise<ChangeFsuCollectionCompartmentResponse>

    ChangeFsuCollectionCompartmentResponse

changeFsuCycleCompartment

  • Moves a Exadata Fleet Update Cycle resource from one compartment identifier 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 ChangeFsuCycleCompartment API.

    Parameters

    Returns Promise<ChangeFsuCycleCompartmentResponse>

    ChangeFsuCycleCompartmentResponse

changeFsuDiscoveryCompartment

  • Moves a Exadata Fleet Update Discovery resource from one compartment identifier 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 ChangeFsuDiscoveryCompartment API.

    Parameters

    Returns Promise<ChangeFsuDiscoveryCompartmentResponse>

    ChangeFsuDiscoveryCompartmentResponse

cloneFsuCycle

  • Clones existing Exadata Fleet Update Cycle details into a new Exadata Fleet Update Cycle 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 CloneFsuCycle API.

    Parameters

    Returns Promise<CloneFsuCycleResponse>

    CloneFsuCycleResponse

close

  • close(): void

createFsuAction

createFsuCollection

createFsuCycle

createFsuDiscovery

createWaiters

deleteFsuAction

deleteFsuCollection

deleteFsuCycle

  • Deletes a Exadata Fleet Update Cycle 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 DeleteFsuCycle API.

    Parameters

    Returns Promise<DeleteFsuCycleResponse>

    DeleteFsuCycleResponse

deleteFsuDiscovery

deleteFsuJob

  • Deletes the Exadata Fleet Update Job 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 DeleteFsuJob API.

    Parameters

    Returns Promise<DeleteFsuJobResponse>

    DeleteFsuJobResponse

getFsuAction

  • Gets a Exadata Fleet Update Action 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 GetFsuAction API.

    Parameters

    Returns Promise<GetFsuActionResponse>

    GetFsuActionResponse

getFsuActionOutputContent

  • Gets the Exadata Fleet Update Action Output content as a binary file (string). This will only include the output from FAILED Exadata Fleet Update Jobs. No content in case there are no FAILED jobs.

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

    Parameters

    Returns Promise<GetFsuActionOutputContentResponse>

    GetFsuActionOutputContentResponse

getFsuCollection

getFsuCycle

  • Gets a Exadata Fleet Update Cycle 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 GetFsuCycle API.

    Parameters

    Returns Promise<GetFsuCycleResponse>

    GetFsuCycleResponse

getFsuDiscovery

getFsuJob

  • Gets a Exadata Fleet Update Job 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 GetFsuJob API.

    Parameters

    Returns Promise<GetFsuJobResponse>

    GetFsuJobResponse

getFsuJobOutputContent

getWaiters

getWorkRequest

  • Gets the status of the work request with the specified 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

listFsuActions

  • Gets a list of all Exadata Fleet Update Actions 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 ListFsuActions API.

    Parameters

    Returns Promise<ListFsuActionsResponse>

    ListFsuActionsResponse

listFsuCollectionTargets

listFsuCollections

listFsuCycles

  • Gets a list of all Exadata Fleet Update Cycles 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 ListFsuCycles API.

    Parameters

    Returns Promise<ListFsuCyclesResponse>

    ListFsuCyclesResponse

listFsuDiscoveries

  • Returns a list of Exadata Fleet Update Discoveries resources in the specified 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 ListFsuDiscoveries API.

    Parameters

    Returns Promise<ListFsuDiscoveriesResponse>

    ListFsuDiscoveriesResponse

listFsuDiscoveryTargets

listFsuJobOutputs

listFsuJobs

  • Lists all the Exadata Fleet Update Jobs associated to the specified Exadata Fleet Update Action.

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

    Parameters

    Returns Promise<ListFsuJobsResponse>

    ListFsuJobsResponse

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

removeFsuCollectionTargets

  • Removes targets from an existing Exadata Fleet Update Collection. This operation can only be performed on Collections that do not have an Action executing under an active Fleet Software Update Cycle. Additionally, during an active Fleet Software Update Cycle, targets can be removed only prior to executing an Apply Action.

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

    Parameters

    Returns Promise<RemoveFsuCollectionTargetsResponse>

    RemoveFsuCollectionTargetsResponse

resumeFsuAction

  • Resumes an Action that has batches of targets waiting to execute.

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

    Parameters

    Returns Promise<ResumeFsuActionResponse>

    ResumeFsuActionResponse

retryFsuJob

  • Retry a failed Job, only while the current Action is being executed. After the Action reaches a terminal state, a new Action of the same kind is required to retry on failed targets.

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

    Parameters

    Returns Promise<RetryFsuJobResponse>

    RetryFsuJobResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateFsuAction

updateFsuCollection

updateFsuCycle

  • Updates the Exadata Fleet Update Cycle identified by the 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 UpdateFsuCycle API.

    Parameters

    Returns Promise<UpdateFsuCycleResponse>

    UpdateFsuCycleResponse

updateFsuDiscovery

updateFsuJob

  • Updates Exadata Fleet Update Job resource details.

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

    Parameters

    Returns Promise<UpdateFsuJobResponse>

    UpdateFsuJobResponse