Package com.oracle.bmc.osmanagementhub

Class DynamicSetClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.osmanagementhub.DynamicSetClient

All Implemented Interfaces:

DynamicSet, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static DynamicSetClient.Builder	builder()	Create a builder for this client.
ChangeDynamicSetCompartmentResponse	changeDynamicSetCompartment(ChangeDynamicSetCompartmentRequest request)	Move the specified Dynamic Set to a different compartment
void	close()
CreateDynamicSetResponse	createDynamicSet(CreateDynamicSetRequest request)	Creates a new dynamic set.
DeleteDynamicSetResponse	deleteDynamicSet(DeleteDynamicSetRequest request)	Deletes the specific dynamic set
void	enableDualStackEndpoints(boolean enableDualStackEndpoints)	This method should be used to enable or disable the use of dual-stack endpoints.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
GetDynamicSetResponse	getDynamicSet(GetDynamicSetRequest request)	Gets information about the specified dynamic set.
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.
DynamicSetPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
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.
DynamicSetWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
InstallPackagesOnDynamicSetResponse	installPackagesOnDynamicSet(InstallPackagesOnDynamicSetRequest request)	Installs specified software packages on all managed instances in the dynamic set.
ListDynamicSetsResponse	listDynamicSets(ListDynamicSetsRequest request)	Lists dynamic sets that match the specified compartment or dynamic set OCID.
ListManagedInstancesInDynamicSetResponse	listManagedInstancesInDynamicSet(ListManagedInstancesInDynamicSetRequest request)	Retrieves a list of managed instances associated with a specified dynamic set.
PreviewManagedInstancesResponse	previewManagedInstances(PreviewManagedInstancesRequest request)	Preview a dynamic set
RebootDynamicSetResponse	rebootDynamicSet(RebootDynamicSetRequest request)	Initiates a reboot of all managed instances within the specified dynamic set.
void	refreshClient()	Rebuild the backing HttpClient.
RemovePackagesFromDynamicSetResponse	removePackagesFromDynamicSet(RemovePackagesFromDynamicSetRequest request)	Removes specified software packages from all managed instances in the dynamic set.
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’).
UpdateDynamicSetResponse	updateDynamicSet(UpdateDynamicSetRequest request)	Updates the specified dynamic set.
UpdatePackagesOnDynamicSetResponse	updatePackagesOnDynamicSet(UpdatePackagesOnDynamicSetRequest request)	Updates all installed software packages on managed instances in the dynamic set.
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.DynamicSet

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DynamicSet.

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

DynamicSetClient

@Deprecated
public DynamicSetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

DynamicSetClient

@Deprecated
public DynamicSetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DynamicSetClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DynamicSetClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DynamicSetClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DynamicSetClient

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

DynamicSetClient

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

DynamicSetClient

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

Method Detail

builder

public static DynamicSetClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DynamicSet

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 DynamicSet

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DynamicSet

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 DynamicSet

Parameters:

regionId - The public region ID.

changeDynamicSetCompartment

public ChangeDynamicSetCompartmentResponse changeDynamicSetCompartment(ChangeDynamicSetCompartmentRequest request)

Description copied from interface: DynamicSet

Move the specified Dynamic Set to a different compartment

Specified by:

changeDynamicSetCompartment in interface DynamicSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDynamicSet

public CreateDynamicSetResponse createDynamicSet(CreateDynamicSetRequest request)

Description copied from interface: DynamicSet

Creates a new dynamic set.

Specified by:

createDynamicSet in interface DynamicSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDynamicSet

public DeleteDynamicSetResponse deleteDynamicSet(DeleteDynamicSetRequest request)

Description copied from interface: DynamicSet

Deletes the specific dynamic set

Specified by:

deleteDynamicSet in interface DynamicSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDynamicSet

public GetDynamicSetResponse getDynamicSet(GetDynamicSetRequest request)

Description copied from interface: DynamicSet

Gets information about the specified dynamic set.

Specified by:

getDynamicSet in interface DynamicSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

installPackagesOnDynamicSet

public InstallPackagesOnDynamicSetResponse installPackagesOnDynamicSet(InstallPackagesOnDynamicSetRequest request)

Description copied from interface: DynamicSet

Installs specified software packages on all managed instances in the dynamic set.

Specified by:

installPackagesOnDynamicSet in interface DynamicSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDynamicSets

public ListDynamicSetsResponse listDynamicSets(ListDynamicSetsRequest request)

Description copied from interface: DynamicSet

Lists dynamic sets that match the specified compartment or dynamic set OCID.

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

Specified by:

listDynamicSets in interface DynamicSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listManagedInstancesInDynamicSet

public ListManagedInstancesInDynamicSetResponse listManagedInstancesInDynamicSet(ListManagedInstancesInDynamicSetRequest request)

Description copied from interface: DynamicSet

Retrieves a list of managed instances associated with a specified dynamic set.

Specified by:

listManagedInstancesInDynamicSet in interface DynamicSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

previewManagedInstances

public PreviewManagedInstancesResponse previewManagedInstances(PreviewManagedInstancesRequest request)

Description copied from interface: DynamicSet

Preview a dynamic set

Specified by:

previewManagedInstances in interface DynamicSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

rebootDynamicSet

public RebootDynamicSetResponse rebootDynamicSet(RebootDynamicSetRequest request)

Description copied from interface: DynamicSet

Initiates a reboot of all managed instances within the specified dynamic set.

Specified by:

rebootDynamicSet in interface DynamicSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removePackagesFromDynamicSet

public RemovePackagesFromDynamicSetResponse removePackagesFromDynamicSet(RemovePackagesFromDynamicSetRequest request)

Description copied from interface: DynamicSet

Removes specified software packages from all managed instances in the dynamic set.

Specified by:

removePackagesFromDynamicSet in interface DynamicSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDynamicSet

public UpdateDynamicSetResponse updateDynamicSet(UpdateDynamicSetRequest request)

Description copied from interface: DynamicSet

Updates the specified dynamic set.

Specified by:

updateDynamicSet in interface DynamicSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updatePackagesOnDynamicSet

public UpdatePackagesOnDynamicSetResponse updatePackagesOnDynamicSet(UpdatePackagesOnDynamicSetRequest request)

Description copied from interface: DynamicSet

Updates all installed software packages on managed instances in the dynamic set.

Specified by:

updatePackagesOnDynamicSet in interface DynamicSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DynamicSetWaiters getWaiters()

Description copied from interface: DynamicSet

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

Specified by:

getWaiters in interface DynamicSet

Returns:

The service waiters.

getPaginators

public DynamicSetPaginators getPaginators()

Description copied from interface: DynamicSet

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 DynamicSet

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