Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LifecycleEnvironmentClient

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

  • LifecycleEnvironmentClient

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

attachManagedInstancesToLifecycleStage

changeLifecycleEnvironmentCompartment

close

  • close(): void

createLifecycleEnvironment

  • Creates a lifecycle environment. A lifecycle environment is a user-defined pipeline to deliver curated, versioned content in a prescribed, methodical manner.

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

    Parameters

    Returns Promise<CreateLifecycleEnvironmentResponse>

    CreateLifecycleEnvironmentResponse

createWaiters

deleteLifecycleEnvironment

detachManagedInstancesFromLifecycleStage

getLifecycleEnvironment

getLifecycleStage

getWaiters

listLifecycleEnvironments

  • Lists lifecycle environments that match the specified compartment or lifecycle environment OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.

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

    Parameters

    Returns Promise<ListLifecycleEnvironmentsResponse>

    ListLifecycleEnvironmentsResponse

listLifecycleStageInstalledPackages

  • Lists installed packages on managed instances in a specified lifecycle stage. Filter the list against a variety of criteria including but not limited to the package name.

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

    Parameters

    Returns Promise<ListLifecycleStageInstalledPackagesResponse>

    ListLifecycleStageInstalledPackagesResponse

listLifecycleStages

  • Lists lifecycle stages that match the specified compartment or lifecycle stage OCID. Filter the list against

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

    Parameters

    Returns Promise<ListLifecycleStagesResponse>

    ListLifecycleStagesResponse

promoteSoftwareSourceToLifecycleStage

  • Updates the versioned custom software source content to the specified lifecycle stage. A versioned custom software source OCID (softwareSourceId) is required when promoting content to the first lifecycle stage. You must promote content to the first stage before promoting to subsequent stages, otherwise the service returns an error. The softwareSourceId is optional when promoting content to the second, third, forth, or fifth stages. If you provide a softwareSourceId, the service validates that it matches the softwareSourceId of the previous stage. If it does not match, the service returns an error. If you don't provide a softwareSourceId, the service promotes the versioned software source from the previous lifecycle stage. If the previous lifecycle stage has no software source, the service returns an error.

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

    Parameters

    Returns Promise<PromoteSoftwareSourceToLifecycleStageResponse>

    PromoteSoftwareSourceToLifecycleStageResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateLifecycleEnvironment