com.oracle.bmc.accessgovernancecp

Class AccessGovernanceCPClient

java.lang.Object

com.oracle.bmc.accessgovernancecp.AccessGovernanceCPClient

All Implemented Interfaces:

AccessGovernanceCP, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220518")
public class AccessGovernanceCPClient
extends Object
implements AccessGovernanceCP

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for AccessGovernanceCP.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AccessGovernanceCPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	AccessGovernanceCPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	AccessGovernanceCPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	AccessGovernanceCPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	AccessGovernanceCPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Creates a new service instance using the given authentication provider and client configuration.
protected	AccessGovernanceCPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	AccessGovernanceCPClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	AccessGovernanceCPClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	AccessGovernanceCPClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

Method Summary

Modifier and Type	Method and Description
static AccessGovernanceCPClient.Builder	builder() Create a builder for this client.
ChangeGovernanceInstanceCompartmentResponse	changeGovernanceInstanceCompartment(ChangeGovernanceInstanceCompartmentRequest request) Moves a GovernanceInstance resource from one compartment identifier to another.
void	close()
CreateGovernanceInstanceResponse	createGovernanceInstance(CreateGovernanceInstanceRequest request) Creates a new GovernanceInstance.
DeleteGovernanceInstanceResponse	deleteGovernanceInstance(DeleteGovernanceInstanceRequest request) Deletes an existing GovernanceInstance.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetGovernanceInstanceResponse	getGovernanceInstance(GetGovernanceInstanceRequest request) Gets a GovernanceInstance by OCID.
GetGovernanceInstanceConfigurationResponse	getGovernanceInstanceConfiguration(GetGovernanceInstanceConfigurationRequest request) Gets the tenancy-wide configuration for GovernanceInstances
AccessGovernanceCPPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
AccessGovernanceCPWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListGovernanceInstancesResponse	listGovernanceInstances(ListGovernanceInstancesRequest request) Returns a list of Governance Instances.
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’).
UpdateGovernanceInstanceResponse	updateGovernanceInstance(UpdateGovernanceInstanceRequest request) Updates the GovernanceInstance.
UpdateGovernanceInstanceConfigurationResponse	updateGovernanceInstanceConfiguration(UpdateGovernanceInstanceConfigurationRequest request) Updates the tenancy-wide configuration for GovernanceInstances
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE

public static final Service SERVICE

Service instance for AccessGovernanceCP.

Constructor Detail

AccessGovernanceCPClient

public AccessGovernanceCPClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

AccessGovernanceCPClient

public AccessGovernanceCPClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration)

Creates a new service instance using the given authentication provider and client configuration.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

AccessGovernanceCPClient

public AccessGovernanceCPClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

AccessGovernanceCPClient

public AccessGovernanceCPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

AccessGovernanceCPClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

AccessGovernanceCPClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

AccessGovernanceCPClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

AccessGovernanceCPClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

AccessGovernanceCPClient

protected AccessGovernanceCPClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory,
                                   Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                   List<ClientConfigurator> additionalClientConfigurators,
                                   String endpoint,
                                   ExecutorService executorService,
                                   RestClientFactoryBuilder restClientFactoryBuilder)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed. Use the AccessGovernanceCPClient.Builder to get access to all these parameters.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static AccessGovernanceCPClient.Builder builder()

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: AccessGovernanceCP

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface AccessGovernanceCP

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AccessGovernanceCP

Sets the endpoint to call (ex, https://www.example.com).

Specified by:

setEndpoint in interface AccessGovernanceCP

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: AccessGovernanceCP

Gets the set endpoint for REST call (ex, https://www.example.com)

Specified by:

getEndpoint in interface AccessGovernanceCP

setRegion

public void setRegion(Region region)

Description copied from interface: AccessGovernanceCP

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 AccessGovernanceCP

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: AccessGovernanceCP

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 AccessGovernanceCP

Parameters:

regionId - The public region ID.

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

Specified by:

useRealmSpecificEndpointTemplate in interface AccessGovernanceCP

Parameters:

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

close

public void close()

Specified by:

close in interface AutoCloseable

changeGovernanceInstanceCompartment

public ChangeGovernanceInstanceCompartmentResponse changeGovernanceInstanceCompartment(ChangeGovernanceInstanceCompartmentRequest request)

Description copied from interface: AccessGovernanceCP

Moves a GovernanceInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeGovernanceInstanceCompartment in interface AccessGovernanceCP

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createGovernanceInstance

public CreateGovernanceInstanceResponse createGovernanceInstance(CreateGovernanceInstanceRequest request)

Description copied from interface: AccessGovernanceCP

Creates a new GovernanceInstance.

Specified by:

createGovernanceInstance in interface AccessGovernanceCP

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteGovernanceInstance

public DeleteGovernanceInstanceResponse deleteGovernanceInstance(DeleteGovernanceInstanceRequest request)

Description copied from interface: AccessGovernanceCP

Deletes an existing GovernanceInstance.

Specified by:

deleteGovernanceInstance in interface AccessGovernanceCP

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getGovernanceInstance

public GetGovernanceInstanceResponse getGovernanceInstance(GetGovernanceInstanceRequest request)

Description copied from interface: AccessGovernanceCP

Gets a GovernanceInstance by OCID.

Specified by:

getGovernanceInstance in interface AccessGovernanceCP

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getGovernanceInstanceConfiguration

public GetGovernanceInstanceConfigurationResponse getGovernanceInstanceConfiguration(GetGovernanceInstanceConfigurationRequest request)

Description copied from interface: AccessGovernanceCP

Gets the tenancy-wide configuration for GovernanceInstances

Specified by:

getGovernanceInstanceConfiguration in interface AccessGovernanceCP

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listGovernanceInstances

public ListGovernanceInstancesResponse listGovernanceInstances(ListGovernanceInstancesRequest request)

Description copied from interface: AccessGovernanceCP

Returns a list of Governance Instances.

Specified by:

listGovernanceInstances in interface AccessGovernanceCP

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateGovernanceInstance

public UpdateGovernanceInstanceResponse updateGovernanceInstance(UpdateGovernanceInstanceRequest request)

Description copied from interface: AccessGovernanceCP

Updates the GovernanceInstance.

Specified by:

updateGovernanceInstance in interface AccessGovernanceCP

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateGovernanceInstanceConfiguration

public UpdateGovernanceInstanceConfigurationResponse updateGovernanceInstanceConfiguration(UpdateGovernanceInstanceConfigurationRequest request)

Description copied from interface: AccessGovernanceCP

Updates the tenancy-wide configuration for GovernanceInstances

Specified by:

updateGovernanceInstanceConfiguration in interface AccessGovernanceCP

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public AccessGovernanceCPWaiters getWaiters()

Description copied from interface: AccessGovernanceCP

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

Specified by:

getWaiters in interface AccessGovernanceCP

Returns:

The service waiters.

getPaginators

public AccessGovernanceCPPaginators getPaginators()

Description copied from interface: AccessGovernanceCP

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 AccessGovernanceCP

Returns:

The service paginators.