|
| 1 | +/** |
| 2 | + * Copyright (c) 2016, 2023, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. |
| 4 | + */ |
| 5 | +package com.oracle.bmc.accessgovernancecp; |
| 6 | + |
| 7 | +import com.oracle.bmc.accessgovernancecp.requests.*; |
| 8 | +import com.oracle.bmc.accessgovernancecp.responses.*; |
| 9 | + |
| 10 | +/** |
| 11 | + * Use the Oracle Access Governance API to create, view, and manage GovernanceInstances. |
| 12 | + * This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user. |
| 13 | + */ |
| 14 | +@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20220518") |
| 15 | +public interface AccessGovernanceCP extends AutoCloseable { |
| 16 | + |
| 17 | + /** |
| 18 | + * Rebuilds the client from scratch. |
| 19 | + * Useful to refresh certificates. |
| 20 | + */ |
| 21 | + void refreshClient(); |
| 22 | + |
| 23 | + /** |
| 24 | + * Sets the endpoint to call (ex, https://www.example.com). |
| 25 | + * @param endpoint The endpoint of the service. |
| 26 | + */ |
| 27 | + void setEndpoint(String endpoint); |
| 28 | + |
| 29 | + /** |
| 30 | + * Gets the set endpoint for REST call (ex, https://www.example.com) |
| 31 | + */ |
| 32 | + String getEndpoint(); |
| 33 | + |
| 34 | + /** |
| 35 | + * Sets the region to call (ex, Region.US_PHOENIX_1). |
| 36 | + * <p> |
| 37 | + * Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised. |
| 38 | + * @param region The region of the service. |
| 39 | + */ |
| 40 | + void setRegion(com.oracle.bmc.Region region); |
| 41 | + |
| 42 | + /** |
| 43 | + * Sets the region to call (ex, 'us-phoenix-1'). |
| 44 | + * <p> |
| 45 | + * Note, this will first try to map the region ID to a known Region and call |
| 46 | + * {@link #setRegion(Region) setRegion}. |
| 47 | + * <p> |
| 48 | + * If no known Region could be determined, it will create an endpoint based on the |
| 49 | + * default endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)} |
| 50 | + * and then call {@link #setEndpoint(String) setEndpoint}. |
| 51 | + * @param regionId The public region ID. |
| 52 | + */ |
| 53 | + void setRegion(String regionId); |
| 54 | + |
| 55 | + /** |
| 56 | + * Determines whether realm specific endpoint should be used or not. |
| 57 | + * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false" |
| 58 | + * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template |
| 59 | + */ |
| 60 | + void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled); |
| 61 | + |
| 62 | + /** |
| 63 | + * Moves a GovernanceInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. |
| 64 | + * @param request The request object containing the details to send |
| 65 | + * @return A response object containing details about the completed operation |
| 66 | + * @throws BmcException when an error occurs. |
| 67 | + * This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. |
| 68 | + * 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 |
| 69 | + * |
| 70 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/accessgovernancecp/ChangeGovernanceInstanceCompartmentExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ChangeGovernanceInstanceCompartment API. |
| 71 | + */ |
| 72 | + ChangeGovernanceInstanceCompartmentResponse changeGovernanceInstanceCompartment( |
| 73 | + ChangeGovernanceInstanceCompartmentRequest request); |
| 74 | + |
| 75 | + /** |
| 76 | + * Creates a new GovernanceInstance. |
| 77 | + * |
| 78 | + * @param request The request object containing the details to send |
| 79 | + * @return A response object containing details about the completed operation |
| 80 | + * @throws BmcException when an error occurs. |
| 81 | + * This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. |
| 82 | + * 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 |
| 83 | + * |
| 84 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/accessgovernancecp/CreateGovernanceInstanceExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use CreateGovernanceInstance API. |
| 85 | + */ |
| 86 | + CreateGovernanceInstanceResponse createGovernanceInstance( |
| 87 | + CreateGovernanceInstanceRequest request); |
| 88 | + |
| 89 | + /** |
| 90 | + * Deletes an existing GovernanceInstance. |
| 91 | + * |
| 92 | + * @param request The request object containing the details to send |
| 93 | + * @return A response object containing details about the completed operation |
| 94 | + * @throws BmcException when an error occurs. |
| 95 | + * This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. |
| 96 | + * 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 |
| 97 | + * |
| 98 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/accessgovernancecp/DeleteGovernanceInstanceExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use DeleteGovernanceInstance API. |
| 99 | + */ |
| 100 | + DeleteGovernanceInstanceResponse deleteGovernanceInstance( |
| 101 | + DeleteGovernanceInstanceRequest request); |
| 102 | + |
| 103 | + /** |
| 104 | + * Gets a GovernanceInstance by OCID. |
| 105 | + * @param request The request object containing the details to send |
| 106 | + * @return A response object containing details about the completed operation |
| 107 | + * @throws BmcException when an error occurs. |
| 108 | + * This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. |
| 109 | + * 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 |
| 110 | + * |
| 111 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/accessgovernancecp/GetGovernanceInstanceExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use GetGovernanceInstance API. |
| 112 | + */ |
| 113 | + GetGovernanceInstanceResponse getGovernanceInstance(GetGovernanceInstanceRequest request); |
| 114 | + |
| 115 | + /** |
| 116 | + * Gets the tenancy-wide configuration for GovernanceInstances |
| 117 | + * @param request The request object containing the details to send |
| 118 | + * @return A response object containing details about the completed operation |
| 119 | + * @throws BmcException when an error occurs. |
| 120 | + * This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. |
| 121 | + * 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 |
| 122 | + * |
| 123 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/accessgovernancecp/GetGovernanceInstanceConfigurationExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use GetGovernanceInstanceConfiguration API. |
| 124 | + */ |
| 125 | + GetGovernanceInstanceConfigurationResponse getGovernanceInstanceConfiguration( |
| 126 | + GetGovernanceInstanceConfigurationRequest request); |
| 127 | + |
| 128 | + /** |
| 129 | + * Returns a list of Governance Instances. |
| 130 | + * |
| 131 | + * @param request The request object containing the details to send |
| 132 | + * @return A response object containing details about the completed operation |
| 133 | + * @throws BmcException when an error occurs. |
| 134 | + * This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. |
| 135 | + * 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 |
| 136 | + * |
| 137 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/accessgovernancecp/ListGovernanceInstancesExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ListGovernanceInstances API. |
| 138 | + */ |
| 139 | + ListGovernanceInstancesResponse listGovernanceInstances(ListGovernanceInstancesRequest request); |
| 140 | + |
| 141 | + /** |
| 142 | + * Updates the GovernanceInstance. |
| 143 | + * @param request The request object containing the details to send |
| 144 | + * @return A response object containing details about the completed operation |
| 145 | + * @throws BmcException when an error occurs. |
| 146 | + * This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. |
| 147 | + * 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 |
| 148 | + * |
| 149 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/accessgovernancecp/UpdateGovernanceInstanceExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use UpdateGovernanceInstance API. |
| 150 | + */ |
| 151 | + UpdateGovernanceInstanceResponse updateGovernanceInstance( |
| 152 | + UpdateGovernanceInstanceRequest request); |
| 153 | + |
| 154 | + /** |
| 155 | + * Updates the tenancy-wide configuration for GovernanceInstances |
| 156 | + * @param request The request object containing the details to send |
| 157 | + * @return A response object containing details about the completed operation |
| 158 | + * @throws BmcException when an error occurs. |
| 159 | + * This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. |
| 160 | + * 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 |
| 161 | + * |
| 162 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/accessgovernancecp/UpdateGovernanceInstanceConfigurationExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use UpdateGovernanceInstanceConfiguration API. |
| 163 | + */ |
| 164 | + UpdateGovernanceInstanceConfigurationResponse updateGovernanceInstanceConfiguration( |
| 165 | + UpdateGovernanceInstanceConfigurationRequest request); |
| 166 | + |
| 167 | + /** |
| 168 | + * Gets the pre-configured waiters available for resources for this service. |
| 169 | + * |
| 170 | + * @return The service waiters. |
| 171 | + */ |
| 172 | + AccessGovernanceCPWaiters getWaiters(); |
| 173 | + |
| 174 | + /** |
| 175 | + * Gets the pre-configured paginators available for list operations in this service which may return multiple |
| 176 | + * pages of data. These paginators provide an {@link java.lang.Iterable} interface so that service responses, or |
| 177 | + * resources/records, can be iterated through without having to manually deal with pagination and page tokens. |
| 178 | + * |
| 179 | + * @return The service paginators. |
| 180 | + */ |
| 181 | + AccessGovernanceCPPaginators getPaginators(); |
| 182 | +} |
0 commit comments