|
| 1 | +/** |
| 2 | + * Copyright (c) 2016, 2021, 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.apmcontrolplane; |
| 6 | + |
| 7 | +import com.oracle.bmc.apmcontrolplane.requests.*; |
| 8 | +import com.oracle.bmc.apmcontrolplane.responses.*; |
| 9 | + |
| 10 | +/** |
| 11 | + * Provide a set of APIs for tenant to perform operations like create, update, delete and list APM domains, and also |
| 12 | + * work request APIs to monitor progress of these operations. |
| 13 | + * |
| 14 | + */ |
| 15 | +@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20200630") |
| 16 | +public interface ApmDomain extends AutoCloseable { |
| 17 | + |
| 18 | + /** |
| 19 | + * Sets the endpoint to call (ex, https://www.example.com). |
| 20 | + * @param endpoint The endpoint of the service. |
| 21 | + */ |
| 22 | + void setEndpoint(String endpoint); |
| 23 | + |
| 24 | + /** |
| 25 | + * Gets the set endpoint for REST call (ex, https://www.example.com) |
| 26 | + */ |
| 27 | + String getEndpoint(); |
| 28 | + |
| 29 | + /** |
| 30 | + * Sets the region to call (ex, Region.US_PHOENIX_1). |
| 31 | + * <p> |
| 32 | + * 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. |
| 33 | + * @param region The region of the service. |
| 34 | + */ |
| 35 | + void setRegion(com.oracle.bmc.Region region); |
| 36 | + |
| 37 | + /** |
| 38 | + * Sets the region to call (ex, 'us-phoenix-1'). |
| 39 | + * <p> |
| 40 | + * Note, this will first try to map the region ID to a known Region and call |
| 41 | + * {@link #setRegion(Region) setRegion}. |
| 42 | + * <p> |
| 43 | + * If no known Region could be determined, it will create an endpoint based on the |
| 44 | + * default endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)} |
| 45 | + * and then call {@link #setEndpoint(String) setEndpoint}. |
| 46 | + * @param regionId The public region ID. |
| 47 | + */ |
| 48 | + void setRegion(String regionId); |
| 49 | + |
| 50 | + /** |
| 51 | + * Moves a APM Domain into a different compartment. When provided, If-Match is checked against ETag values of the resource. |
| 52 | + * @param request The request object containing the details to send |
| 53 | + * @return A response object containing details about the completed operation |
| 54 | + * @throws BmcException when an error occurs. |
| 55 | + * |
| 56 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/ChangeApmDomainCompartmentExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ChangeApmDomainCompartment API. |
| 57 | + */ |
| 58 | + ChangeApmDomainCompartmentResponse changeApmDomainCompartment( |
| 59 | + ChangeApmDomainCompartmentRequest request); |
| 60 | + |
| 61 | + /** |
| 62 | + * Creates a new APM Domain. |
| 63 | + * |
| 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 | + * |
| 68 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/CreateApmDomainExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use CreateApmDomain API. |
| 69 | + */ |
| 70 | + CreateApmDomainResponse createApmDomain(CreateApmDomainRequest request); |
| 71 | + |
| 72 | + /** |
| 73 | + * Delete the specified APM domain asynchronously. The APM domain is placed in the 'Deleting' state and will stop |
| 74 | + * accepting any operation requests. All resources associated with the APM domain are eventually recovered. Use the |
| 75 | + * returned work request to track the progress of the background activity to complete deleting the domain. |
| 76 | + * |
| 77 | + * @param request The request object containing the details to send |
| 78 | + * @return A response object containing details about the completed operation |
| 79 | + * @throws BmcException when an error occurs. |
| 80 | + * |
| 81 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/DeleteApmDomainExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use DeleteApmDomain API. |
| 82 | + */ |
| 83 | + DeleteApmDomainResponse deleteApmDomain(DeleteApmDomainRequest request); |
| 84 | + |
| 85 | + /** |
| 86 | + * Generates a set of new Data Keys for the specified APM domain with the specified names and |
| 87 | + * types. These will be added to the existing set of Data Keys for the specified APM domain. |
| 88 | + * |
| 89 | + * @param request The request object containing the details to send |
| 90 | + * @return A response object containing details about the completed operation |
| 91 | + * @throws BmcException when an error occurs. |
| 92 | + * |
| 93 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/GenerateDataKeysExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use GenerateDataKeys API. |
| 94 | + */ |
| 95 | + GenerateDataKeysResponse generateDataKeys(GenerateDataKeysRequest request); |
| 96 | + |
| 97 | + /** |
| 98 | + * Gets details of APM Domain by identifier |
| 99 | + * @param request The request object containing the details to send |
| 100 | + * @return A response object containing details about the completed operation |
| 101 | + * @throws BmcException when an error occurs. |
| 102 | + * |
| 103 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/GetApmDomainExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use GetApmDomain API. |
| 104 | + */ |
| 105 | + GetApmDomainResponse getApmDomain(GetApmDomainRequest request); |
| 106 | + |
| 107 | + /** |
| 108 | + * Gets the details of the work request with the given ID. |
| 109 | + * @param request The request object containing the details to send |
| 110 | + * @return A response object containing details about the completed operation |
| 111 | + * @throws BmcException when an error occurs. |
| 112 | + * |
| 113 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/GetWorkRequestExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use GetWorkRequest API. |
| 114 | + */ |
| 115 | + GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request); |
| 116 | + |
| 117 | + /** |
| 118 | + * Returns a (paginated) list of work requests related to a specific APM Domain. |
| 119 | + * |
| 120 | + * @param request The request object containing the details to send |
| 121 | + * @return A response object containing details about the completed operation |
| 122 | + * @throws BmcException when an error occurs. |
| 123 | + * |
| 124 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/ListApmDomainWorkRequestsExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ListApmDomainWorkRequests API. |
| 125 | + */ |
| 126 | + ListApmDomainWorkRequestsResponse listApmDomainWorkRequests( |
| 127 | + ListApmDomainWorkRequestsRequest request); |
| 128 | + |
| 129 | + /** |
| 130 | + * Lists all APM Domains for the specified tenant compartment. |
| 131 | + * |
| 132 | + * @param request The request object containing the details to send |
| 133 | + * @return A response object containing details about the completed operation |
| 134 | + * @throws BmcException when an error occurs. |
| 135 | + * |
| 136 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/ListApmDomainsExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ListApmDomains API. |
| 137 | + */ |
| 138 | + ListApmDomainsResponse listApmDomains(ListApmDomainsRequest request); |
| 139 | + |
| 140 | + /** |
| 141 | + * Lists all Data Keys for the specified APM Domain. The caller may filter the list by specifying the 'dataKeyType' |
| 142 | + * query parameter. |
| 143 | + * |
| 144 | + * @param request The request object containing the details to send |
| 145 | + * @return A response object containing details about the completed operation |
| 146 | + * @throws BmcException when an error occurs. |
| 147 | + * |
| 148 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/ListDataKeysExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ListDataKeys API. |
| 149 | + */ |
| 150 | + ListDataKeysResponse listDataKeys(ListDataKeysRequest request); |
| 151 | + |
| 152 | + /** |
| 153 | + * Return a (paginated) list of errors for a given work request. |
| 154 | + * |
| 155 | + * @param request The request object containing the details to send |
| 156 | + * @return A response object containing details about the completed operation |
| 157 | + * @throws BmcException when an error occurs. |
| 158 | + * |
| 159 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/ListWorkRequestErrorsExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ListWorkRequestErrors API. |
| 160 | + */ |
| 161 | + ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request); |
| 162 | + |
| 163 | + /** |
| 164 | + * Return a (paginated) list of logs for a given work request. |
| 165 | + * |
| 166 | + * @param request The request object containing the details to send |
| 167 | + * @return A response object containing details about the completed operation |
| 168 | + * @throws BmcException when an error occurs. |
| 169 | + * |
| 170 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/ListWorkRequestLogsExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ListWorkRequestLogs API. |
| 171 | + */ |
| 172 | + ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request); |
| 173 | + |
| 174 | + /** |
| 175 | + * Returns a (paginated) list of work requests in a given compartment. |
| 176 | + * |
| 177 | + * @param request The request object containing the details to send |
| 178 | + * @return A response object containing details about the completed operation |
| 179 | + * @throws BmcException when an error occurs. |
| 180 | + * |
| 181 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/ListWorkRequestsExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use ListWorkRequests API. |
| 182 | + */ |
| 183 | + ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request); |
| 184 | + |
| 185 | + /** |
| 186 | + * Removes the set of specified Data Keys from the specified APM domain. Agents would no longer |
| 187 | + * be able to use these data keys to upload to the APM domain once this operation is completed. |
| 188 | + * |
| 189 | + * @param request The request object containing the details to send |
| 190 | + * @return A response object containing details about the completed operation |
| 191 | + * @throws BmcException when an error occurs. |
| 192 | + * |
| 193 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/RemoveDataKeysExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use RemoveDataKeys API. |
| 194 | + */ |
| 195 | + RemoveDataKeysResponse removeDataKeys(RemoveDataKeysRequest request); |
| 196 | + |
| 197 | + /** |
| 198 | + * Update the APM domain when it is ready and active. |
| 199 | + * @param request The request object containing the details to send |
| 200 | + * @return A response object containing details about the completed operation |
| 201 | + * @throws BmcException when an error occurs. |
| 202 | + * |
| 203 | + * <b>Example: </b>Click <a href="https://docs.cloud.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/apmcontrolplane/UpdateApmDomainExample.java.html" target="_blank" rel="noopener noreferrer" >here</a> to see how to use UpdateApmDomain API. |
| 204 | + */ |
| 205 | + UpdateApmDomainResponse updateApmDomain(UpdateApmDomainRequest request); |
| 206 | + |
| 207 | + /** |
| 208 | + * Gets the pre-configured waiters available for resources for this service. |
| 209 | + * |
| 210 | + * @return The service waiters. |
| 211 | + */ |
| 212 | + ApmDomainWaiters getWaiters(); |
| 213 | + |
| 214 | + /** |
| 215 | + * Gets the pre-configured paginators available for list operations in this service which may return multiple |
| 216 | + * pages of data. These paginators provide an {@link java.lang.Iterable} interface so that service responses, or |
| 217 | + * resources/records, can be iterated through without having to manually deal with pagination and page tokens. |
| 218 | + * |
| 219 | + * @return The service paginators. |
| 220 | + */ |
| 221 | + ApmDomainPaginators getPaginators(); |
| 222 | +} |
0 commit comments