Package com.oracle.bmc.osmanagementhub

Class OnboardingClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.osmanagementhub.OnboardingClient

All Implemented Interfaces:

Onboarding, AutoCloseable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OnboardingClient.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 Onboarding.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AttachLifecycleStageToProfileResponse	attachLifecycleStageToProfile(AttachLifecycleStageToProfileRequest request)	Attaches the specified lifecycle stage to a profile.
AttachManagedInstanceGroupToProfileResponse	attachManagedInstanceGroupToProfile(AttachManagedInstanceGroupToProfileRequest request)	Attaches the specified managed instance group to a profile.
AttachManagementStationToProfileResponse	attachManagementStationToProfile(AttachManagementStationToProfileRequest request)	Attaches the specified management station to a profile.
AttachSoftwareSourcesToProfileResponse	attachSoftwareSourcesToProfile(AttachSoftwareSourcesToProfileRequest request)	Attaches the specified software sources to a profile.
static OnboardingClient.Builder	builder()	Create a builder for this client.
ChangeProfileCompartmentResponse	changeProfileCompartment(ChangeProfileCompartmentRequest request)	Moves the profile to a different compartment.
void	close()
CreateProfileResponse	createProfile(CreateProfileRequest request)	Creates a registration profile.
DeleteProfileResponse	deleteProfile(DeleteProfileRequest request)	Deletes a specified registration profile.
DetachSoftwareSourcesFromProfileResponse	detachSoftwareSourcesFromProfile(DetachSoftwareSourcesFromProfileRequest request)	Detaches the specified software sources from a profile.
void	enableDualStackEndpoints(boolean enableDualStackEndpoints)	This method should be used to enable or disable the use of dual-stack endpoints.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()	Get the endpoint of the client.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Map<String,Boolean>	getOptionsMap()	Return an immutable snapshot representing the current options set for this client.
OnboardingPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetProfileResponse	getProfile(GetProfileRequest request)	Returns information about the specified registration profile.
GetProfileVersionResponse	getProfileVersion(GetProfileVersionRequest request)	Returns information about the version of the specified registration profile.
String	getResolvedEndpoint(Map<String,Object> requiredParametersMap)	Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
OnboardingWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListProfileAvailableSoftwareSourcesResponse	listProfileAvailableSoftwareSources(ListProfileAvailableSoftwareSourcesRequest request)	Lists available software sources for a specified profile.
ListProfilesResponse	listProfiles(ListProfilesRequest request)	Lists registration profiles that match the specified compartment or profile OCID.
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’).
UpdateProfileResponse	updateProfile(UpdateProfileRequest request)	Updates the specified profile’s name, description, and 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.Onboarding

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Onboarding.

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

OnboardingClient

@Deprecated
public OnboardingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

OnboardingClient

@Deprecated
public OnboardingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

OnboardingClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

OnboardingClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OnboardingClient

@Deprecated
public OnboardingClient(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 OnboardingClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OnboardingClient

@Deprecated
public OnboardingClient(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 OnboardingClient.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)

OnboardingClient

@Deprecated
public OnboardingClient(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 OnboardingClient.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

OnboardingClient

@Deprecated
public OnboardingClient(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 OnboardingClient.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 - OnboardingClient.Builder.executorService

Method Detail

builder

public static OnboardingClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Onboarding

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 Onboarding

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Onboarding

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 Onboarding

Parameters:

regionId - The public region ID.

attachLifecycleStageToProfile

public AttachLifecycleStageToProfileResponse attachLifecycleStageToProfile(AttachLifecycleStageToProfileRequest request)

Description copied from interface: Onboarding

Attaches the specified lifecycle stage to a profile.

Specified by:

attachLifecycleStageToProfile in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

attachManagedInstanceGroupToProfile

public AttachManagedInstanceGroupToProfileResponse attachManagedInstanceGroupToProfile(AttachManagedInstanceGroupToProfileRequest request)

Description copied from interface: Onboarding

Attaches the specified managed instance group to a profile.

Specified by:

attachManagedInstanceGroupToProfile in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

attachManagementStationToProfile

public AttachManagementStationToProfileResponse attachManagementStationToProfile(AttachManagementStationToProfileRequest request)

Description copied from interface: Onboarding

Attaches the specified management station to a profile.

Specified by:

attachManagementStationToProfile in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

attachSoftwareSourcesToProfile

public AttachSoftwareSourcesToProfileResponse attachSoftwareSourcesToProfile(AttachSoftwareSourcesToProfileRequest request)

Description copied from interface: Onboarding

Attaches the specified software sources to a profile.

Specified by:

attachSoftwareSourcesToProfile in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeProfileCompartment

public ChangeProfileCompartmentResponse changeProfileCompartment(ChangeProfileCompartmentRequest request)

Description copied from interface: Onboarding

Moves the profile to a different compartment.

Specified by:

changeProfileCompartment in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createProfile

public CreateProfileResponse createProfile(CreateProfileRequest request)

Description copied from interface: Onboarding

Creates a registration profile.

A profile defines the content applied to the instance when registering it with the service.

Specified by:

createProfile in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteProfile

public DeleteProfileResponse deleteProfile(DeleteProfileRequest request)

Description copied from interface: Onboarding

Deletes a specified registration profile.

Specified by:

deleteProfile in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

detachSoftwareSourcesFromProfile

public DetachSoftwareSourcesFromProfileResponse detachSoftwareSourcesFromProfile(DetachSoftwareSourcesFromProfileRequest request)

Description copied from interface: Onboarding

Detaches the specified software sources from a profile.

Specified by:

detachSoftwareSourcesFromProfile in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getProfile

public GetProfileResponse getProfile(GetProfileRequest request)

Description copied from interface: Onboarding

Returns information about the specified registration profile.

Specified by:

getProfile in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getProfileVersion

public GetProfileVersionResponse getProfileVersion(GetProfileVersionRequest request)

Description copied from interface: Onboarding

Returns information about the version of the specified registration profile.

Specified by:

getProfileVersion in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listProfileAvailableSoftwareSources

public ListProfileAvailableSoftwareSourcesResponse listProfileAvailableSoftwareSources(ListProfileAvailableSoftwareSourcesRequest request)

Description copied from interface: Onboarding

Lists available software sources for a specified profile.

Filter the list against a variety of criteria including but not limited to the software source name. The results list only software sources that have not already been added to the profile.

Specified by:

listProfileAvailableSoftwareSources in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listProfiles

public ListProfilesResponse listProfiles(ListProfilesRequest request)

Description copied from interface: Onboarding

Lists registration profiles that match the specified compartment or profile OCID.

Filter the list against a variety of criteria including but not limited to its name, status, vendor name, and architecture type.

Specified by:

listProfiles in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateProfile

public UpdateProfileResponse updateProfile(UpdateProfileRequest request)

Description copied from interface: Onboarding

Updates the specified profile’s name, description, and tags.

Specified by:

updateProfile in interface Onboarding

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public OnboardingWaiters getWaiters()

Description copied from interface: Onboarding

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

Specified by:

getWaiters in interface Onboarding

Returns:

The service waiters.

getPaginators

public OnboardingPaginators getPaginators()

Description copied from interface: Onboarding

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 Onboarding

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

enableDualStackEndpoints

public void enableDualStackEndpoints(boolean enableDualStackEndpoints)

This method should be used to enable or disable the use of dual-stack endpoints.

The default value is false i.e. dual-stack endpoints are disabled by default.

Parameters:

enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively

getOptionsMap

public Map<String,Boolean> getOptionsMap()

Return an immutable snapshot representing the current options set for this client.

Returns:

immutable snapshot representing the current options set for this client

getResolvedEndpoint

public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)

Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.

Parameters:

requiredParametersMap - the map from required parameter name to their values

Returns:

resolved endpoint, with all options and placeholders filled in

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

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

Get the endpoint of the client.

Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.

Examples of endpoints this may return:

• Unparameterized endpoints

               https://identity.us-phoenix-1.oci.oraclecloud.com
               https://identity.us-ashburn-1.oci.oraclecloud.com
               https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
           

• Parameterized endpoints with placeholders

               https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com
               https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
           

• Parameterized endpoints with options

               https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com
               https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
           

• Parameterized endpoints with placeholders and options

               https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com
               https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
           

To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).

Returns:

the endpoint being used by the client

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()