|
| 1 | +/** |
| 2 | + * Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved. |
| 3 | + */ |
| 4 | +package com.oracle.bmc.containerengine; |
| 5 | + |
| 6 | +import com.oracle.bmc.containerengine.requests.*; |
| 7 | +import com.oracle.bmc.containerengine.responses.*; |
| 8 | + |
| 9 | +@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20180222") |
| 10 | +public interface ContainerEngine extends AutoCloseable { |
| 11 | + |
| 12 | + /** |
| 13 | + * Sets the endpoint to call (ex, https://www.example.com). |
| 14 | + * @param endpoint The endpoint of the service. |
| 15 | + */ |
| 16 | + void setEndpoint(String endpoint); |
| 17 | + |
| 18 | + /** |
| 19 | + * Sets the region to call (ex, Region.US_PHOENIX_1). |
| 20 | + * <p> |
| 21 | + * 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. |
| 22 | + * @param region The region of the service. |
| 23 | + */ |
| 24 | + void setRegion(com.oracle.bmc.Region region); |
| 25 | + |
| 26 | + /** |
| 27 | + * Sets the region to call (ex, 'us-phoenix-1'). |
| 28 | + * <p> |
| 29 | + * Note, this will first try to map the region ID to a known Region and call |
| 30 | + * {@link #setRegion(Region) setRegion}. |
| 31 | + * <p> |
| 32 | + * If no known Region could be determined, it will create an endpoint based on the |
| 33 | + * default endpoint format ({@link Region#formatDefaultRegionEndpoint(Service, String)} |
| 34 | + * and then call {@link #setEndpoint(String) setEndpoint}. |
| 35 | + * @param regionId The public region ID. |
| 36 | + */ |
| 37 | + void setRegion(String regionId); |
| 38 | + |
| 39 | + /** |
| 40 | + * Create a new cluster. |
| 41 | + * @param request The request object containing the details to send |
| 42 | + * @return A response object containing details about the completed operation |
| 43 | + * @throws BmcException when an error occurs. |
| 44 | + */ |
| 45 | + CreateClusterResponse createCluster(CreateClusterRequest request); |
| 46 | + |
| 47 | + /** |
| 48 | + * Create the Kubeconfig YAML for a cluster. |
| 49 | + * @param request The request object containing the details to send |
| 50 | + * @return A response object containing details about the completed operation |
| 51 | + * @throws BmcException when an error occurs. |
| 52 | + */ |
| 53 | + CreateKubeconfigResponse createKubeconfig(CreateKubeconfigRequest request); |
| 54 | + |
| 55 | + /** |
| 56 | + * Create a new node pool. |
| 57 | + * @param request The request object containing the details to send |
| 58 | + * @return A response object containing details about the completed operation |
| 59 | + * @throws BmcException when an error occurs. |
| 60 | + */ |
| 61 | + CreateNodePoolResponse createNodePool(CreateNodePoolRequest request); |
| 62 | + |
| 63 | + /** |
| 64 | + * Delete a cluster. |
| 65 | + * @param request The request object containing the details to send |
| 66 | + * @return A response object containing details about the completed operation |
| 67 | + * @throws BmcException when an error occurs. |
| 68 | + */ |
| 69 | + DeleteClusterResponse deleteCluster(DeleteClusterRequest request); |
| 70 | + |
| 71 | + /** |
| 72 | + * Delete a node pool. |
| 73 | + * @param request The request object containing the details to send |
| 74 | + * @return A response object containing details about the completed operation |
| 75 | + * @throws BmcException when an error occurs. |
| 76 | + */ |
| 77 | + DeleteNodePoolResponse deleteNodePool(DeleteNodePoolRequest request); |
| 78 | + |
| 79 | + /** |
| 80 | + * Cancel a work request that has not started. |
| 81 | + * @param request The request object containing the details to send |
| 82 | + * @return A response object containing details about the completed operation |
| 83 | + * @throws BmcException when an error occurs. |
| 84 | + */ |
| 85 | + DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request); |
| 86 | + |
| 87 | + /** |
| 88 | + * Get the details of a cluster. |
| 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 | + GetClusterResponse getCluster(GetClusterRequest request); |
| 94 | + |
| 95 | + /** |
| 96 | + * Get options available for clusters. |
| 97 | + * @param request The request object containing the details to send |
| 98 | + * @return A response object containing details about the completed operation |
| 99 | + * @throws BmcException when an error occurs. |
| 100 | + */ |
| 101 | + GetClusterOptionsResponse getClusterOptions(GetClusterOptionsRequest request); |
| 102 | + |
| 103 | + /** |
| 104 | + * Get the details of a node pool. |
| 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 | + */ |
| 109 | + GetNodePoolResponse getNodePool(GetNodePoolRequest request); |
| 110 | + |
| 111 | + /** |
| 112 | + * Get options available for node pools. |
| 113 | + * @param request The request object containing the details to send |
| 114 | + * @return A response object containing details about the completed operation |
| 115 | + * @throws BmcException when an error occurs. |
| 116 | + */ |
| 117 | + GetNodePoolOptionsResponse getNodePoolOptions(GetNodePoolOptionsRequest request); |
| 118 | + |
| 119 | + /** |
| 120 | + * Get the details of a work request. |
| 121 | + * @param request The request object containing the details to send |
| 122 | + * @return A response object containing details about the completed operation |
| 123 | + * @throws BmcException when an error occurs. |
| 124 | + */ |
| 125 | + GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request); |
| 126 | + |
| 127 | + /** |
| 128 | + * List all the cluster objects in a compartment. |
| 129 | + * @param request The request object containing the details to send |
| 130 | + * @return A response object containing details about the completed operation |
| 131 | + * @throws BmcException when an error occurs. |
| 132 | + */ |
| 133 | + ListClustersResponse listClusters(ListClustersRequest request); |
| 134 | + |
| 135 | + /** |
| 136 | + * List all the node pools in a compartment, and optionally filter by cluster. |
| 137 | + * @param request The request object containing the details to send |
| 138 | + * @return A response object containing details about the completed operation |
| 139 | + * @throws BmcException when an error occurs. |
| 140 | + */ |
| 141 | + ListNodePoolsResponse listNodePools(ListNodePoolsRequest request); |
| 142 | + |
| 143 | + /** |
| 144 | + * Get the errors of a work request. |
| 145 | + * @param request The request object containing the details to send |
| 146 | + * @return A response object containing details about the completed operation |
| 147 | + * @throws BmcException when an error occurs. |
| 148 | + */ |
| 149 | + ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request); |
| 150 | + |
| 151 | + /** |
| 152 | + * Get the logs of a work request. |
| 153 | + * @param request The request object containing the details to send |
| 154 | + * @return A response object containing details about the completed operation |
| 155 | + * @throws BmcException when an error occurs. |
| 156 | + */ |
| 157 | + ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request); |
| 158 | + |
| 159 | + /** |
| 160 | + * List all work requests in a compartment. |
| 161 | + * @param request The request object containing the details to send |
| 162 | + * @return A response object containing details about the completed operation |
| 163 | + * @throws BmcException when an error occurs. |
| 164 | + */ |
| 165 | + ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request); |
| 166 | + |
| 167 | + /** |
| 168 | + * Update the details of a cluster. |
| 169 | + * @param request The request object containing the details to send |
| 170 | + * @return A response object containing details about the completed operation |
| 171 | + * @throws BmcException when an error occurs. |
| 172 | + */ |
| 173 | + UpdateClusterResponse updateCluster(UpdateClusterRequest request); |
| 174 | + |
| 175 | + /** |
| 176 | + * Update the details of a node pool. |
| 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 | + UpdateNodePoolResponse updateNodePool(UpdateNodePoolRequest request); |
| 182 | + |
| 183 | + /** |
| 184 | + * Gets the pre-configured waiters available for resources for this service. |
| 185 | + * |
| 186 | + * @return The service waiters. |
| 187 | + */ |
| 188 | + ContainerEngineWaiters getWaiters(); |
| 189 | + |
| 190 | + /** |
| 191 | + * Gets the pre-configured paginators available for list operations in this service which may return multiple |
| 192 | + * pages of data. These paginators provide an {@link java.lang.Iterable} interface so that service responses, or |
| 193 | + * resources/records, can be iterated through without having to manually deal with pagination and page tokens. |
| 194 | + * |
| 195 | + * @return The service paginators. |
| 196 | + */ |
| 197 | + ContainerEnginePaginators getPaginators(); |
| 198 | +} |
0 commit comments