Package com.oracle.bmc.osmanagementhub

Class LifecycleEnvironmentClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.osmanagementhub.LifecycleEnvironmentClient

All Implemented Interfaces:

LifecycleEnvironment, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public class LifecycleEnvironmentClient
extends BaseSyncClient
implements LifecycleEnvironment

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LifecycleEnvironmentClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for LifecycleEnvironment.

Constructor Summary

Constructors

Constructor	Description
LifecycleEnvironmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
LifecycleEnvironmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
LifecycleEnvironmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
LifecycleEnvironmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
LifecycleEnvironmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
LifecycleEnvironmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
LifecycleEnvironmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
LifecycleEnvironmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
AttachManagedInstancesToLifecycleStageResponse	attachManagedInstancesToLifecycleStage(AttachManagedInstancesToLifecycleStageRequest request)	Attaches (adds) managed instances to a lifecycle stage.
static LifecycleEnvironmentClient.Builder	builder()	Create a builder for this client.
ChangeLifecycleEnvironmentCompartmentResponse	changeLifecycleEnvironmentCompartment(ChangeLifecycleEnvironmentCompartmentRequest request)	Moves a lifecycle environment into a different compartment within the same tenancy.
void	close()
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	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetLifecycleEnvironmentResponse	getLifecycleEnvironment(GetLifecycleEnvironmentRequest request)	Gets information about the specified lifecycle environment.
GetLifecycleStageResponse	getLifecycleStage(GetLifecycleStageRequest request)	Returns information about the specified lifecycle stage.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
PromoteSoftwareSourceToLifecycleStageResponse	promoteSoftwareSourceToLifecycleStage(PromoteSoftwareSourceToLifecycleStageRequest request)	Updates the versioned custom software source content to the specified lifecycle stage.
RebootLifecycleStageResponse	rebootLifecycleStage(RebootLifecycleStageRequest request)	Reboots all managed instances in the specified lifecycle stage.
void	refreshClient()	Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateLifecycleEnvironmentResponse	updateLifecycleEnvironment(UpdateLifecycleEnvironmentRequest request)	Updates the specified lifecycle environment’s name, description, stages, or tags.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.osmanagementhub.LifecycleEnvironment

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for LifecycleEnvironment.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

LifecycleEnvironmentClient

@Deprecated
public LifecycleEnvironmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LifecycleEnvironmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

LifecycleEnvironmentClient

@Deprecated
public LifecycleEnvironmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LifecycleEnvironmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

LifecycleEnvironmentClient

@Deprecated
public LifecycleEnvironmentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration,
                                  ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LifecycleEnvironmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

LifecycleEnvironmentClient

@Deprecated
public LifecycleEnvironmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration,
                                  ClientConfigurator clientConfigurator,
                                  RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LifecycleEnvironmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

LifecycleEnvironmentClient

@Deprecated
public LifecycleEnvironmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration,
                                  ClientConfigurator clientConfigurator,
                                  RequestSignerFactory defaultRequestSignerFactory,
                                  List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LifecycleEnvironmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

LifecycleEnvironmentClient

@Deprecated
public LifecycleEnvironmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration,
                                  ClientConfigurator clientConfigurator,
                                  RequestSignerFactory defaultRequestSignerFactory,
                                  List<ClientConfigurator> additionalClientConfigurators,
                                  String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LifecycleEnvironmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

LifecycleEnvironmentClient

@Deprecated
public LifecycleEnvironmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration,
                                  ClientConfigurator clientConfigurator,
                                  RequestSignerFactory defaultRequestSignerFactory,
                                  Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                  List<ClientConfigurator> additionalClientConfigurators,
                                  String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LifecycleEnvironmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

LifecycleEnvironmentClient

@Deprecated
public LifecycleEnvironmentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration,
                                  ClientConfigurator clientConfigurator,
                                  RequestSignerFactory defaultRequestSignerFactory,
                                  Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                  List<ClientConfigurator> additionalClientConfigurators,
                                  String endpoint,
                                  ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see LifecycleEnvironmentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - LifecycleEnvironmentClient.Builder.executorService

Method Detail

builder

public static LifecycleEnvironmentClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: LifecycleEnvironment

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.

Specified by:

setRegion in interface LifecycleEnvironment

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: LifecycleEnvironment

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.

Specified by:

setRegion in interface LifecycleEnvironment

Parameters:

regionId - The public region ID.

attachManagedInstancesToLifecycleStage

public AttachManagedInstancesToLifecycleStageResponse attachManagedInstancesToLifecycleStage(AttachManagedInstancesToLifecycleStageRequest request)

Description copied from interface: LifecycleEnvironment

Attaches (adds) managed instances to a lifecycle stage.

Once added, you can apply operations to all managed instances in the lifecycle stage.

Specified by:

attachManagedInstancesToLifecycleStage in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeLifecycleEnvironmentCompartment

public ChangeLifecycleEnvironmentCompartmentResponse changeLifecycleEnvironmentCompartment(ChangeLifecycleEnvironmentCompartmentRequest request)

Description copied from interface: LifecycleEnvironment

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.

Specified by:

changeLifecycleEnvironmentCompartment in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createLifecycleEnvironment

public CreateLifecycleEnvironmentResponse createLifecycleEnvironment(CreateLifecycleEnvironmentRequest request)

Description copied from interface: LifecycleEnvironment

Creates a lifecycle environment.

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

Specified by:

createLifecycleEnvironment in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteLifecycleEnvironment

public DeleteLifecycleEnvironmentResponse deleteLifecycleEnvironment(DeleteLifecycleEnvironmentRequest request)

Description copied from interface: LifecycleEnvironment

Deletes the specified lifecycle environment.

Specified by:

deleteLifecycleEnvironment in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

detachManagedInstancesFromLifecycleStage

public DetachManagedInstancesFromLifecycleStageResponse detachManagedInstancesFromLifecycleStage(DetachManagedInstancesFromLifecycleStageRequest request)

Description copied from interface: LifecycleEnvironment

Detaches (removes) a managed instance from a lifecycle stage.

Specified by:

detachManagedInstancesFromLifecycleStage in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getLifecycleEnvironment

public GetLifecycleEnvironmentResponse getLifecycleEnvironment(GetLifecycleEnvironmentRequest request)

Description copied from interface: LifecycleEnvironment

Gets information about the specified lifecycle environment.

Specified by:

getLifecycleEnvironment in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getLifecycleStage

public GetLifecycleStageResponse getLifecycleStage(GetLifecycleStageRequest request)

Description copied from interface: LifecycleEnvironment

Returns information about the specified lifecycle stage.

Specified by:

getLifecycleStage in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listLifecycleEnvironments

public ListLifecycleEnvironmentsResponse listLifecycleEnvironments(ListLifecycleEnvironmentsRequest request)

Description copied from interface: LifecycleEnvironment

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.

Specified by:

listLifecycleEnvironments in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listLifecycleStageInstalledPackages

public ListLifecycleStageInstalledPackagesResponse listLifecycleStageInstalledPackages(ListLifecycleStageInstalledPackagesRequest request)

Description copied from interface: LifecycleEnvironment

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.

Specified by:

listLifecycleStageInstalledPackages in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listLifecycleStages

public ListLifecycleStagesResponse listLifecycleStages(ListLifecycleStagesRequest request)

Description copied from interface: LifecycleEnvironment

Lists lifecycle stages that match the specified compartment or lifecycle stage OCID.

Filter the list against

Specified by:

listLifecycleStages in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

promoteSoftwareSourceToLifecycleStage

public PromoteSoftwareSourceToLifecycleStageResponse promoteSoftwareSourceToLifecycleStage(PromoteSoftwareSourceToLifecycleStageRequest request)

Description copied from interface: LifecycleEnvironment

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.

Specified by:

promoteSoftwareSourceToLifecycleStage in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

rebootLifecycleStage

public RebootLifecycleStageResponse rebootLifecycleStage(RebootLifecycleStageRequest request)

Description copied from interface: LifecycleEnvironment

Reboots all managed instances in the specified lifecycle stage.

Specified by:

rebootLifecycleStage in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateLifecycleEnvironment

public UpdateLifecycleEnvironmentResponse updateLifecycleEnvironment(UpdateLifecycleEnvironmentRequest request)

Description copied from interface: LifecycleEnvironment

Updates the specified lifecycle environment’s name, description, stages, or tags.

Specified by:

updateLifecycleEnvironment in interface LifecycleEnvironment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public LifecycleEnvironmentWaiters getWaiters()

Description copied from interface: LifecycleEnvironment

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface LifecycleEnvironment

Returns:

The service waiters.

getPaginators

public LifecycleEnvironmentPaginators getPaginators()

Description copied from interface: LifecycleEnvironment

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.

Specified by:

getPaginators in interface LifecycleEnvironment

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()