Package com.oracle.bmc.governancerulescontrolplane

Interface GovernanceRule

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    GovernanceRuleClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220504")
public interface GovernanceRule
extends AutoCloseable
    A description of the GovernanceRulesControlPlane API This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

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

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • createGovernanceRule

        CreateGovernanceRuleResponse createGovernanceRule​(CreateGovernanceRuleRequest request)
        Create governance rule in the root compartment only.

        Either relatedResourceId or template must be supplied.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/CreateGovernanceRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateGovernanceRule API.

      • createInclusionCriterion

        CreateInclusionCriterionResponse createInclusionCriterion​(CreateInclusionCriterionRequest request)
        Create inclusion criterion of type tenancy or tag for the governance rule.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/CreateInclusionCriterionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateInclusionCriterion API.

      • deleteGovernanceRule

        DeleteGovernanceRuleResponse deleteGovernanceRule​(DeleteGovernanceRuleRequest request)
        Delete the specified governance rule.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/DeleteGovernanceRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteGovernanceRule API.

      • deleteInclusionCriterion

        DeleteInclusionCriterionResponse deleteInclusionCriterion​(DeleteInclusionCriterionRequest request)
        Delete the specified inclusion criterion.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/DeleteInclusionCriterionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteInclusionCriterion API.

      • getEnforcedGovernanceRule

        GetEnforcedGovernanceRuleResponse getEnforcedGovernanceRule​(GetEnforcedGovernanceRuleRequest request)
        Get the specified enforced governance rule’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/GetEnforcedGovernanceRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetEnforcedGovernanceRule API.

      • getGovernanceRule

        GetGovernanceRuleResponse getGovernanceRule​(GetGovernanceRuleRequest request)
        Get the specified governance rule’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/GetGovernanceRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetGovernanceRule API.

      • getInclusionCriterion

        GetInclusionCriterionResponse getInclusionCriterion​(GetInclusionCriterionRequest request)
        Get the specified inclusion criterion’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/GetInclusionCriterionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetInclusionCriterion API.

      • getTenancyAttachment

        GetTenancyAttachmentResponse getTenancyAttachment​(GetTenancyAttachmentRequest request)
        Get the specified tenancy attachment’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/GetTenancyAttachmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetTenancyAttachment API.

      • listEnforcedGovernanceRules

        ListEnforcedGovernanceRulesResponse listEnforcedGovernanceRules​(ListEnforcedGovernanceRulesRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/ListEnforcedGovernanceRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEnforcedGovernanceRules API.

      • listGovernanceRules

        ListGovernanceRulesResponse listGovernanceRules​(ListGovernanceRulesRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/ListGovernanceRulesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListGovernanceRules API.

      • listInclusionCriteria

        ListInclusionCriteriaResponse listInclusionCriteria​(ListInclusionCriteriaRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/ListInclusionCriteriaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInclusionCriteria API.

      • listTenancyAttachments

        ListTenancyAttachmentsResponse listTenancyAttachments​(ListTenancyAttachmentsRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/ListTenancyAttachmentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListTenancyAttachments API.

      • retryGovernanceRule

        RetryGovernanceRuleResponse retryGovernanceRule​(RetryGovernanceRuleRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/RetryGovernanceRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RetryGovernanceRule API.

      • retryTenancyAttachment

        RetryTenancyAttachmentResponse retryTenancyAttachment​(RetryTenancyAttachmentRequest request)
        Retry governance rule application for the specified tenancy attachment id.

        Used by the tenancy admins when all the workflow retries have exhausted.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/RetryTenancyAttachmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RetryTenancyAttachment API.

      • updateGovernanceRule

        UpdateGovernanceRuleResponse updateGovernanceRule​(UpdateGovernanceRuleRequest request)
        Update the specified governance rule.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/governancerulescontrolplane/UpdateGovernanceRuleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateGovernanceRule API.

      • getWaiters

        GovernanceRuleWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        GovernanceRulePaginators getPaginators()
        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.

        Returns:
        The service paginators.