@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.
Modifier and Type | Method and Description |
---|---|
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 |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
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.
|
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 |
refreshClient()
Rebuilds the client from scratch.
|
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)
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’).
|
UpdateGovernanceRuleResponse |
updateGovernanceRule(UpdateGovernanceRuleRequest request)
Update the specified governance rule.
|
void |
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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
.
regionId
- The public region ID.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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateCreateGovernanceRuleResponse createGovernanceRule(CreateGovernanceRuleRequest request)
Create governance rule in the root compartment only. Either relatedResourceId or template must be supplied.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use CreateGovernanceRule API.
CreateInclusionCriterionResponse createInclusionCriterion(CreateInclusionCriterionRequest request)
Create inclusion criterion of type tenancy or tag for the governance rule.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use CreateInclusionCriterion API.
DeleteGovernanceRuleResponse deleteGovernanceRule(DeleteGovernanceRuleRequest request)
Delete the specified governance rule.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use DeleteGovernanceRule API.
DeleteInclusionCriterionResponse deleteInclusionCriterion(DeleteInclusionCriterionRequest request)
Delete the specified inclusion criterion.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use DeleteInclusionCriterion API.
GetEnforcedGovernanceRuleResponse getEnforcedGovernanceRule(GetEnforcedGovernanceRuleRequest request)
Get the specified enforced governance rule’s information.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use GetEnforcedGovernanceRule API.
GetGovernanceRuleResponse getGovernanceRule(GetGovernanceRuleRequest request)
Get the specified governance rule’s information.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use GetGovernanceRule API.
GetInclusionCriterionResponse getInclusionCriterion(GetInclusionCriterionRequest request)
Get the specified inclusion criterion’s information.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use GetInclusionCriterion API.
GetTenancyAttachmentResponse getTenancyAttachment(GetTenancyAttachmentRequest request)
Get the specified tenancy attachment’s information.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use GetTenancyAttachment API.
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.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use ListEnforcedGovernanceRules API.
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.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use ListGovernanceRules API.
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.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use ListInclusionCriteria API.
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.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use ListTenancyAttachments API.
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.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use RetryGovernanceRule API.
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.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use RetryTenancyAttachment API.
UpdateGovernanceRuleResponse updateGovernanceRule(UpdateGovernanceRuleRequest request)
Update the specified governance rule.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use UpdateGovernanceRule API.
GovernanceRuleWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
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.
Copyright © 2016–2024. All rights reserved.