com.oracle.bmc.fleetappsmanagement

Class FleetAppsManagementAdminClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.fleetappsmanagement.FleetAppsManagementAdminClient

All Implemented Interfaces:

FleetAppsManagementAdmin, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230831")
public class FleetAppsManagementAdminClient
extends BaseSyncClient
implements FleetAppsManagementAdmin

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and 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 FleetAppsManagementAdmin.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FleetAppsManagementAdminClient.Builder	builder() Create a builder for this client.
void	close()
CreateOnboardingResponse	createOnboarding(CreateOnboardingRequest request) Onboard a tenant to Fleet Application Management Service
CreatePropertyResponse	createProperty(CreatePropertyRequest request) Creates a new Property.
DeletePropertyResponse	deleteProperty(DeletePropertyRequest request) Deletes a Property resource by identifier
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
FleetAppsManagementAdminPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPropertyResponse	getProperty(GetPropertyRequest request) Gets a Property by identifier
FleetAppsManagementAdminWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListOnboardingPoliciesResponse	listOnboardingPolicies(ListOnboardingPoliciesRequest request) Returns a list of onboarding policy information for FAMS.
ListOnboardingsResponse	listOnboardings(ListOnboardingsRequest request) Returns a list of onboarding information for the Tenancy.
ListPropertiesResponse	listProperties(ListPropertiesRequest request) Returns a list of Properties for Tenancy.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
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.
UpdatePropertyResponse	updateProperty(UpdatePropertyRequest request) Updates the Property
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 com.oracle.bmc.fleetappsmanagement.FleetAppsManagementAdmin

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for FleetAppsManagementAdmin.

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

FleetAppsManagementAdminClient

@Deprecated
public FleetAppsManagementAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

FleetAppsManagementAdminClient

@Deprecated
public FleetAppsManagementAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                  ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

FleetAppsManagementAdminClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

FleetAppsManagementAdminClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

FleetAppsManagementAdminClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

FleetAppsManagementAdminClient

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

FleetAppsManagementAdminClient

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

FleetAppsManagementAdminClient

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

Method Detail

builder

public static FleetAppsManagementAdminClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: FleetAppsManagementAdmin

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 FleetAppsManagementAdmin

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: FleetAppsManagementAdmin

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 FleetAppsManagementAdmin

Parameters:

regionId - The public region ID.

createOnboarding

public CreateOnboardingResponse createOnboarding(CreateOnboardingRequest request)

Description copied from interface: FleetAppsManagementAdmin

Onboard a tenant to Fleet Application Management Service

Specified by:

createOnboarding in interface FleetAppsManagementAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createProperty

public CreatePropertyResponse createProperty(CreatePropertyRequest request)

Description copied from interface: FleetAppsManagementAdmin

Creates a new Property.

Specified by:

createProperty in interface FleetAppsManagementAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteProperty

public DeletePropertyResponse deleteProperty(DeletePropertyRequest request)

Description copied from interface: FleetAppsManagementAdmin

Deletes a Property resource by identifier

Specified by:

deleteProperty in interface FleetAppsManagementAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getProperty

public GetPropertyResponse getProperty(GetPropertyRequest request)

Description copied from interface: FleetAppsManagementAdmin

Gets a Property by identifier

Specified by:

getProperty in interface FleetAppsManagementAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOnboardingPolicies

public ListOnboardingPoliciesResponse listOnboardingPolicies(ListOnboardingPoliciesRequest request)

Description copied from interface: FleetAppsManagementAdmin

Returns a list of onboarding policy information for FAMS.

Specified by:

listOnboardingPolicies in interface FleetAppsManagementAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOnboardings

public ListOnboardingsResponse listOnboardings(ListOnboardingsRequest request)

Description copied from interface: FleetAppsManagementAdmin

Returns a list of onboarding information for the Tenancy.

Specified by:

listOnboardings in interface FleetAppsManagementAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listProperties

public ListPropertiesResponse listProperties(ListPropertiesRequest request)

Description copied from interface: FleetAppsManagementAdmin

Returns a list of Properties for Tenancy.

Specified by:

listProperties in interface FleetAppsManagementAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateProperty

public UpdatePropertyResponse updateProperty(UpdatePropertyRequest request)

Description copied from interface: FleetAppsManagementAdmin

Updates the Property

Specified by:

updateProperty in interface FleetAppsManagementAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public FleetAppsManagementAdminWaiters getWaiters()

Description copied from interface: FleetAppsManagementAdmin

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

Specified by:

getWaiters in interface FleetAppsManagementAdmin

Returns:

The service waiters.

getPaginators

public FleetAppsManagementAdminPaginators getPaginators()

Description copied from interface: FleetAppsManagementAdmin

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 FleetAppsManagementAdmin

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