|
62 | 62 | * <p>Note: close() needs to be called on the CloudQuotasClient object to clean up resources such as |
63 | 63 | * threads. In the example above, try-with-resources is used, which automatically calls close(). |
64 | 64 | * |
65 | | - * <p>The surface of this class includes several types of Java methods for each of the API's |
66 | | - * methods: |
67 | | - * |
68 | | - * <ol> |
69 | | - * <li>A "flattened" method. With this type of method, the fields of the request type have been |
70 | | - * converted into function parameters. It may be the case that not all fields are available as |
71 | | - * parameters, and not every API method will have a flattened method entry point. |
72 | | - * <li>A "request object" method. This type of method only takes one parameter, a request object, |
73 | | - * which must be constructed before the call. Not every API method will have a request object |
74 | | - * method. |
75 | | - * <li>A "callable" method. This type of method takes no parameters and returns an immutable API |
76 | | - * callable object, which can be used to initiate calls to the service. |
77 | | - * </ol> |
| 65 | + * <table> |
| 66 | + * <tr> |
| 67 | + * <th>Method</th> |
| 68 | + * <th>Description</th> |
| 69 | + * <th>Method Variants</th> |
| 70 | + * <tr> |
| 71 | + * <td>ListQuotaInfos</td> |
| 72 | + * <td><p> Lists QuotaInfos of all quotas for a given project, folder or organization.</td> |
| 73 | + * <td> |
| 74 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 75 | + * <ul> |
| 76 | + * <li>listQuotaInfos(ListQuotaInfosRequest request) |
| 77 | + * </ul> |
| 78 | + * <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p> |
| 79 | + * <ul> |
| 80 | + * <li>listQuotaInfos(ServiceName parent) |
| 81 | + * <li>listQuotaInfos(String parent) |
| 82 | + * </ul> |
| 83 | + * <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p> |
| 84 | + * <ul> |
| 85 | + * <li>listQuotaInfosPagedCallable() |
| 86 | + * <li>listQuotaInfosCallable() |
| 87 | + * </ul> |
| 88 | + * </td> |
| 89 | + * </tr> |
| 90 | + * <tr> |
| 91 | + * <td>GetQuotaInfo</td> |
| 92 | + * <td><p> Retrieve the QuotaInfo of a quota for a project, folder or organization.</td> |
| 93 | + * <td> |
| 94 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 95 | + * <ul> |
| 96 | + * <li>getQuotaInfo(GetQuotaInfoRequest request) |
| 97 | + * </ul> |
| 98 | + * <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p> |
| 99 | + * <ul> |
| 100 | + * <li>getQuotaInfo(QuotaInfoName name) |
| 101 | + * <li>getQuotaInfo(String name) |
| 102 | + * </ul> |
| 103 | + * <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p> |
| 104 | + * <ul> |
| 105 | + * <li>getQuotaInfoCallable() |
| 106 | + * </ul> |
| 107 | + * </td> |
| 108 | + * </tr> |
| 109 | + * <tr> |
| 110 | + * <td>ListQuotaPreferences</td> |
| 111 | + * <td><p> Lists QuotaPreferences in a given project, folder or organization.</td> |
| 112 | + * <td> |
| 113 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 114 | + * <ul> |
| 115 | + * <li>listQuotaPreferences(ListQuotaPreferencesRequest request) |
| 116 | + * </ul> |
| 117 | + * <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p> |
| 118 | + * <ul> |
| 119 | + * <li>listQuotaPreferences(LocationName parent) |
| 120 | + * <li>listQuotaPreferences(String parent) |
| 121 | + * </ul> |
| 122 | + * <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p> |
| 123 | + * <ul> |
| 124 | + * <li>listQuotaPreferencesPagedCallable() |
| 125 | + * <li>listQuotaPreferencesCallable() |
| 126 | + * </ul> |
| 127 | + * </td> |
| 128 | + * </tr> |
| 129 | + * <tr> |
| 130 | + * <td>GetQuotaPreference</td> |
| 131 | + * <td><p> Gets details of a single QuotaPreference.</td> |
| 132 | + * <td> |
| 133 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 134 | + * <ul> |
| 135 | + * <li>getQuotaPreference(GetQuotaPreferenceRequest request) |
| 136 | + * </ul> |
| 137 | + * <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p> |
| 138 | + * <ul> |
| 139 | + * <li>getQuotaPreference(QuotaPreferenceName name) |
| 140 | + * <li>getQuotaPreference(String name) |
| 141 | + * </ul> |
| 142 | + * <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p> |
| 143 | + * <ul> |
| 144 | + * <li>getQuotaPreferenceCallable() |
| 145 | + * </ul> |
| 146 | + * </td> |
| 147 | + * </tr> |
| 148 | + * <tr> |
| 149 | + * <td>CreateQuotaPreference</td> |
| 150 | + * <td><p> Creates a new QuotaPreference that declares the desired value for a quota.</td> |
| 151 | + * <td> |
| 152 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 153 | + * <ul> |
| 154 | + * <li>createQuotaPreference(CreateQuotaPreferenceRequest request) |
| 155 | + * </ul> |
| 156 | + * <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p> |
| 157 | + * <ul> |
| 158 | + * <li>createQuotaPreference(LocationName parent, QuotaPreference quotaPreference) |
| 159 | + * <li>createQuotaPreference(String parent, QuotaPreference quotaPreference) |
| 160 | + * <li>createQuotaPreference(LocationName parent, QuotaPreference quotaPreference, String quotaPreferenceId) |
| 161 | + * <li>createQuotaPreference(String parent, QuotaPreference quotaPreference, String quotaPreferenceId) |
| 162 | + * </ul> |
| 163 | + * <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p> |
| 164 | + * <ul> |
| 165 | + * <li>createQuotaPreferenceCallable() |
| 166 | + * </ul> |
| 167 | + * </td> |
| 168 | + * </tr> |
| 169 | + * <tr> |
| 170 | + * <td>UpdateQuotaPreference</td> |
| 171 | + * <td><p> Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval.</td> |
| 172 | + * <td> |
| 173 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 174 | + * <ul> |
| 175 | + * <li>updateQuotaPreference(UpdateQuotaPreferenceRequest request) |
| 176 | + * </ul> |
| 177 | + * <p>"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.</p> |
| 178 | + * <ul> |
| 179 | + * <li>updateQuotaPreference(QuotaPreference quotaPreference, FieldMask updateMask) |
| 180 | + * </ul> |
| 181 | + * <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p> |
| 182 | + * <ul> |
| 183 | + * <li>updateQuotaPreferenceCallable() |
| 184 | + * </ul> |
| 185 | + * </td> |
| 186 | + * </tr> |
| 187 | + * </tr> |
| 188 | + * </table> |
78 | 189 | * |
79 | 190 | * <p>See the individual methods for example code. |
80 | 191 | * |
|
0 commit comments