com.oracle.bmc.osmanagementhub

Interface OnboardingAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

OnboardingAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public interface OnboardingAsync
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.

Method Summary

Modifier and Type	Method and Description
Future<ChangeProfileCompartmentResponse>	changeProfileCompartment(ChangeProfileCompartmentRequest request, AsyncHandler<ChangeProfileCompartmentRequest,ChangeProfileCompartmentResponse> handler) Moves the profile to a different compartment.
Future<CreateProfileResponse>	createProfile(CreateProfileRequest request, AsyncHandler<CreateProfileRequest,CreateProfileResponse> handler) Creates a registration profile.
Future<DeleteProfileResponse>	deleteProfile(DeleteProfileRequest request, AsyncHandler<DeleteProfileRequest,DeleteProfileResponse> handler) Deletes a specified registration profile.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetProfileResponse>	getProfile(GetProfileRequest request, AsyncHandler<GetProfileRequest,GetProfileResponse> handler) Gets information about the specified registration profile.
Future<ListProfilesResponse>	listProfiles(ListProfilesRequest request, AsyncHandler<ListProfilesRequest,ListProfilesResponse> handler) Lists registration profiles that match the specified compartment or profile OCID.
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’).
Future<UpdateProfileResponse>	updateProfile(UpdateProfileRequest request, AsyncHandler<UpdateProfileRequest,UpdateProfileResponse> handler) Updates the specified profile’s name, description, and 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 serice.

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

changeProfileCompartment

Future<ChangeProfileCompartmentResponse> changeProfileCompartment(ChangeProfileCompartmentRequest request,
                                                                  AsyncHandler<ChangeProfileCompartmentRequest,ChangeProfileCompartmentResponse> handler)

Moves the profile to a different compartment.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createProfile

Future<CreateProfileResponse> createProfile(CreateProfileRequest request,
                                            AsyncHandler<CreateProfileRequest,CreateProfileResponse> handler)

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

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteProfile

Future<DeleteProfileResponse> deleteProfile(DeleteProfileRequest request,
                                            AsyncHandler<DeleteProfileRequest,DeleteProfileResponse> handler)

Deletes a specified registration profile.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getProfile

Future<GetProfileResponse> getProfile(GetProfileRequest request,
                                      AsyncHandler<GetProfileRequest,GetProfileResponse> handler)

Gets information about the specified registration profile.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listProfiles

Future<ListProfilesResponse> listProfiles(ListProfilesRequest request,
                                          AsyncHandler<ListProfilesRequest,ListProfilesResponse> handler)

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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateProfile

Future<UpdateProfileResponse> updateProfile(UpdateProfileRequest request,
                                            AsyncHandler<UpdateProfileRequest,UpdateProfileResponse> handler)

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

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.