LifecycleEnvironment (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

LifecycleEnvironmentClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public interface LifecycleEnvironment
extends AutoCloseable
```
Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. For more information, see Overview of OS Management Hub.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AttachManagedInstancesToLifecycleStageResponse`	`attachManagedInstancesToLifecycleStage(AttachManagedInstancesToLifecycleStageRequest request)` Attaches (adds) managed instances to a lifecycle stage.
`ChangeLifecycleEnvironmentCompartmentResponse`	`changeLifecycleEnvironmentCompartment(ChangeLifecycleEnvironmentCompartmentRequest request)` Moves a lifecycle environment into a different compartment within the same tenancy.
`CreateLifecycleEnvironmentResponse`	`createLifecycleEnvironment(CreateLifecycleEnvironmentRequest request)` Creates a lifecycle environment.
`DeleteLifecycleEnvironmentResponse`	`deleteLifecycleEnvironment(DeleteLifecycleEnvironmentRequest request)` Deletes the specified lifecycle environment.
`DetachManagedInstancesFromLifecycleStageResponse`	`detachManagedInstancesFromLifecycleStage(DetachManagedInstancesFromLifecycleStageRequest request)` Detaches (removes) a managed instance from a lifecycle stage.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`GetLifecycleEnvironmentResponse`	`getLifecycleEnvironment(GetLifecycleEnvironmentRequest request)` Gets information about the specified lifecycle environment.
`GetLifecycleStageResponse`	`getLifecycleStage(GetLifecycleStageRequest request)` Returns information about the specified lifecycle stage.
`LifecycleEnvironmentPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`LifecycleEnvironmentWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`ListLifecycleEnvironmentsResponse`	`listLifecycleEnvironments(ListLifecycleEnvironmentsRequest request)` Lists lifecycle environments that match the specified compartment or lifecycle environment OCID.
`ListLifecycleStageInstalledPackagesResponse`	`listLifecycleStageInstalledPackages(ListLifecycleStageInstalledPackagesRequest request)` Lists installed packages on managed instances in a specified lifecycle stage.
`ListLifecycleStagesResponse`	`listLifecycleStages(ListLifecycleStagesRequest request)` Lists lifecycle stages that match the specified compartment or lifecycle stage OCID.
`PromoteSoftwareSourceToLifecycleStageResponse`	`promoteSoftwareSourceToLifecycleStage(PromoteSoftwareSourceToLifecycleStageRequest request)` Updates the versioned custom software source content to the specified lifecycle stage.
`void`	`refreshClient()` Rebuilds the client from scratch.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`UpdateLifecycleEnvironmentResponse`	`updateLifecycleEnvironment(UpdateLifecycleEnvironmentRequest request)` Updates the specified lifecycle environment’s name, description, stages, or tags.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    Sets the region to call (ex, Region.US_PHOENIX_1).
    
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    Sets the region to call (ex, ‘us-phoenix-1’).
    
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    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 - flag to enable the use of realm specific endpoint template
  - attachManagedInstancesToLifecycleStage
```
AttachManagedInstancesToLifecycleStageResponse attachManagedInstancesToLifecycleStage(AttachManagedInstancesToLifecycleStageRequest request)
```
    Attaches (adds) managed instances to a lifecycle stage. Once added, you can apply operations to all managed instances in the lifecycle stage.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use AttachManagedInstancesToLifecycleStage API.
  - changeLifecycleEnvironmentCompartment
```
ChangeLifecycleEnvironmentCompartmentResponse changeLifecycleEnvironmentCompartment(ChangeLifecycleEnvironmentCompartmentRequest request)
```
    Moves a lifecycle environment into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeLifecycleEnvironmentCompartment API.
  - createLifecycleEnvironment
```
CreateLifecycleEnvironmentResponse createLifecycleEnvironment(CreateLifecycleEnvironmentRequest request)
```
    Creates a lifecycle environment. A lifecycle environment is a user-defined pipeline to deliver curated, versioned content in a prescribed, methodical manner.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateLifecycleEnvironment API.
  - deleteLifecycleEnvironment
```
DeleteLifecycleEnvironmentResponse deleteLifecycleEnvironment(DeleteLifecycleEnvironmentRequest request)
```
    Deletes the specified lifecycle environment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteLifecycleEnvironment API.
  - detachManagedInstancesFromLifecycleStage
```
DetachManagedInstancesFromLifecycleStageResponse detachManagedInstancesFromLifecycleStage(DetachManagedInstancesFromLifecycleStageRequest request)
```
    Detaches (removes) a managed instance from a lifecycle stage.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DetachManagedInstancesFromLifecycleStage API.
  - getLifecycleEnvironment
```
GetLifecycleEnvironmentResponse getLifecycleEnvironment(GetLifecycleEnvironmentRequest request)
```
    Gets information about the specified lifecycle environment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetLifecycleEnvironment API.
  - getLifecycleStage
```
GetLifecycleStageResponse getLifecycleStage(GetLifecycleStageRequest request)
```
    Returns information about the specified lifecycle stage.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetLifecycleStage API.
  - listLifecycleEnvironments
```
ListLifecycleEnvironmentsResponse listLifecycleEnvironments(ListLifecycleEnvironmentsRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListLifecycleEnvironments API.
  - listLifecycleStageInstalledPackages
```
ListLifecycleStageInstalledPackagesResponse listLifecycleStageInstalledPackages(ListLifecycleStageInstalledPackagesRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListLifecycleStageInstalledPackages API.
  - listLifecycleStages
```
ListLifecycleStagesResponse listLifecycleStages(ListLifecycleStagesRequest request)
```
    Lists lifecycle stages that match the specified compartment or lifecycle stage OCID. Filter the list against
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListLifecycleStages API.
  - promoteSoftwareSourceToLifecycleStage
```
PromoteSoftwareSourceToLifecycleStageResponse promoteSoftwareSourceToLifecycleStage(PromoteSoftwareSourceToLifecycleStageRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use PromoteSoftwareSourceToLifecycleStage API.
  - updateLifecycleEnvironment
```
UpdateLifecycleEnvironmentResponse updateLifecycleEnvironment(UpdateLifecycleEnvironmentRequest request)
```
    Updates the specified lifecycle environment’s name, description, stages, or tags.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateLifecycleEnvironment API.
  - getWaiters
```
LifecycleEnvironmentWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
LifecycleEnvironmentPaginators getPaginators()
```
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Returns:
    
    The service paginators.

Interface LifecycleEnvironment

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

attachManagedInstancesToLifecycleStage

changeLifecycleEnvironmentCompartment

createLifecycleEnvironment

deleteLifecycleEnvironment

detachManagedInstancesFromLifecycleStage

getLifecycleEnvironment

getLifecycleStage

listLifecycleEnvironments

listLifecycleStageInstalledPackages

listLifecycleStages

promoteSoftwareSourceToLifecycleStage

updateLifecycleEnvironment

getWaiters

getPaginators