com.oracle.bmc.governancerulescontrolplane

Class GovernanceRuleClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.governancerulescontrolplane.GovernanceRuleClient

All Implemented Interfaces:

GovernanceRule, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220504")
public class GovernanceRuleClient
extends BaseSyncClient
implements GovernanceRule

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static GovernanceRuleClient.Builder	builder() Create a builder for this client.
void	close()
CreateGovernanceRuleResponse	createGovernanceRule(CreateGovernanceRuleRequest request) Create governance rule in the root compartment only.
CreateInclusionCriterionResponse	createInclusionCriterion(CreateInclusionCriterionRequest request) Create inclusion criterion of type tenancy or tag for the governance rule.
DeleteGovernanceRuleResponse	deleteGovernanceRule(DeleteGovernanceRuleRequest request) Delete the specified governance rule.
DeleteInclusionCriterionResponse	deleteInclusionCriterion(DeleteInclusionCriterionRequest request) Delete the specified inclusion criterion.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetEnforcedGovernanceRuleResponse	getEnforcedGovernanceRule(GetEnforcedGovernanceRuleRequest request) Get the specified enforced governance rule’s information.
GetGovernanceRuleResponse	getGovernanceRule(GetGovernanceRuleRequest request) Get the specified governance rule’s information.
GetInclusionCriterionResponse	getInclusionCriterion(GetInclusionCriterionRequest request) Get the specified inclusion criterion’s information.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GovernanceRulePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetTenancyAttachmentResponse	getTenancyAttachment(GetTenancyAttachmentRequest request) Get the specified tenancy attachment’s information.
GovernanceRuleWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListEnforcedGovernanceRulesResponse	listEnforcedGovernanceRules(ListEnforcedGovernanceRulesRequest request) List enforced governance rules.
ListGovernanceRulesResponse	listGovernanceRules(ListGovernanceRulesRequest request) List governance rules.
ListInclusionCriteriaResponse	listInclusionCriteria(ListInclusionCriteriaRequest request) List inclusion criteria associated with a governance rule.
ListTenancyAttachmentsResponse	listTenancyAttachments(ListTenancyAttachmentsRequest request) List tenancy attachments.
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.
RetryGovernanceRuleResponse	retryGovernanceRule(RetryGovernanceRuleRequest request) Retry the creation of the specified governance rule.
RetryTenancyAttachmentResponse	retryTenancyAttachment(RetryTenancyAttachmentRequest request) Retry governance rule application for the specified tenancy attachment id.
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.
UpdateGovernanceRuleResponse	updateGovernanceRule(UpdateGovernanceRuleRequest request) Update the specified governance rule.
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.governancerulescontrolplane.GovernanceRule

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for GovernanceRule.

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

GovernanceRuleClient

@Deprecated
public GovernanceRuleClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

GovernanceRuleClient

@Deprecated
public GovernanceRuleClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

GovernanceRuleClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

GovernanceRuleClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

GovernanceRuleClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

GovernanceRuleClient

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

GovernanceRuleClient

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

GovernanceRuleClient

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

Method Detail

builder

public static GovernanceRuleClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: GovernanceRule

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 GovernanceRule

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: GovernanceRule

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 GovernanceRule

Parameters:

regionId - The public region ID.

createGovernanceRule

public CreateGovernanceRuleResponse createGovernanceRule(CreateGovernanceRuleRequest request)

Description copied from interface: GovernanceRule

Create governance rule in the root compartment only. Either relatedResourceId or template must be supplied.

Specified by:

createGovernanceRule in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createInclusionCriterion

public CreateInclusionCriterionResponse createInclusionCriterion(CreateInclusionCriterionRequest request)

Description copied from interface: GovernanceRule

Create inclusion criterion of type tenancy or tag for the governance rule.

Specified by:

createInclusionCriterion in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteGovernanceRule

public DeleteGovernanceRuleResponse deleteGovernanceRule(DeleteGovernanceRuleRequest request)

Description copied from interface: GovernanceRule

Delete the specified governance rule.

Specified by:

deleteGovernanceRule in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteInclusionCriterion

public DeleteInclusionCriterionResponse deleteInclusionCriterion(DeleteInclusionCriterionRequest request)

Description copied from interface: GovernanceRule

Delete the specified inclusion criterion.

Specified by:

deleteInclusionCriterion in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getEnforcedGovernanceRule

public GetEnforcedGovernanceRuleResponse getEnforcedGovernanceRule(GetEnforcedGovernanceRuleRequest request)

Description copied from interface: GovernanceRule

Get the specified enforced governance rule’s information.

Specified by:

getEnforcedGovernanceRule in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getGovernanceRule

public GetGovernanceRuleResponse getGovernanceRule(GetGovernanceRuleRequest request)

Description copied from interface: GovernanceRule

Get the specified governance rule’s information.

Specified by:

getGovernanceRule in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getInclusionCriterion

public GetInclusionCriterionResponse getInclusionCriterion(GetInclusionCriterionRequest request)

Description copied from interface: GovernanceRule

Get the specified inclusion criterion’s information.

Specified by:

getInclusionCriterion in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getTenancyAttachment

public GetTenancyAttachmentResponse getTenancyAttachment(GetTenancyAttachmentRequest request)

Description copied from interface: GovernanceRule

Get the specified tenancy attachment’s information.

Specified by:

getTenancyAttachment in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listEnforcedGovernanceRules

public ListEnforcedGovernanceRulesResponse listEnforcedGovernanceRules(ListEnforcedGovernanceRulesRequest request)

Description copied from interface: GovernanceRule

List enforced governance rules. Either compartment id or enforced governance rule id must be supplied. An optional governance rule type or a display name can also be supplied.

Specified by:

listEnforcedGovernanceRules in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listGovernanceRules

public ListGovernanceRulesResponse listGovernanceRules(ListGovernanceRulesRequest request)

Description copied from interface: GovernanceRule

List governance rules. Either compartment id or governance rule id must be supplied. An optional lifecycle state, display name or a governance rule type can also be supplied.

Specified by:

listGovernanceRules in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listInclusionCriteria

public ListInclusionCriteriaResponse listInclusionCriteria(ListInclusionCriteriaRequest request)

Description copied from interface: GovernanceRule

List inclusion criteria associated with a governance rule. Governance rule id must be supplied. An optional inclusion criterion id or a lifecycle state can also be supplied.

Specified by:

listInclusionCriteria in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTenancyAttachments

public ListTenancyAttachmentsResponse listTenancyAttachments(ListTenancyAttachmentsRequest request)

Description copied from interface: GovernanceRule

List tenancy attachments. Either compartment id, governance rule id or tenancy attachment id must be supplied. An optional lifecycle state or a child tenancy id can also be supplied.

Specified by:

listTenancyAttachments in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

retryGovernanceRule

public RetryGovernanceRuleResponse retryGovernanceRule(RetryGovernanceRuleRequest request)

Description copied from interface: GovernanceRule

Retry the creation of the specified governance rule. Used by the tenancy admins when all the workflow retries have exhausted. When provided, If-Match is checked against ETag values of the resource.

Specified by:

retryGovernanceRule in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

retryTenancyAttachment

public RetryTenancyAttachmentResponse retryTenancyAttachment(RetryTenancyAttachmentRequest request)

Description copied from interface: GovernanceRule

Retry governance rule application for the specified tenancy attachment id. Used by the tenancy admins when all the workflow retries have exhausted.

Specified by:

retryTenancyAttachment in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateGovernanceRule

public UpdateGovernanceRuleResponse updateGovernanceRule(UpdateGovernanceRuleRequest request)

Description copied from interface: GovernanceRule

Update the specified governance rule.

Specified by:

updateGovernanceRule in interface GovernanceRule

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public GovernanceRuleWaiters getWaiters()

Description copied from interface: GovernanceRule

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

Specified by:

getWaiters in interface GovernanceRule

Returns:

The service waiters.

getPaginators

public GovernanceRulePaginators getPaginators()

Description copied from interface: GovernanceRule

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 GovernanceRule

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