|
66 | 66 | * such as threads. In the example above, try-with-resources is used, which automatically calls |
67 | 67 | * close(). |
68 | 68 | * |
69 | | - * <p>The surface of this class includes several types of Java methods for each of the API's |
70 | | - * methods: |
71 | | - * |
72 | | - * <ol> |
73 | | - * <li>A "flattened" method. With this type of method, the fields of the request type have been |
74 | | - * converted into function parameters. It may be the case that not all fields are available as |
75 | | - * parameters, and not every API method will have a flattened method entry point. |
76 | | - * <li>A "request object" method. This type of method only takes one parameter, a request object, |
77 | | - * which must be constructed before the call. Not every API method will have a request object |
78 | | - * method. |
79 | | - * <li>A "callable" method. This type of method takes no parameters and returns an immutable API |
80 | | - * callable object, which can be used to initiate calls to the service. |
81 | | - * </ol> |
| 69 | + * <table> |
| 70 | + * <tr> |
| 71 | + * <th>Method</th> |
| 72 | + * <th>Description</th> |
| 73 | + * <th>Method Variants</th> |
| 74 | + * <tr> |
| 75 | + * <td>CreateTaxonomy</td> |
| 76 | + * <td><p> Creates a taxonomy in a specified project. |
| 77 | + * <p> The taxonomy is initially empty, that is, it doesn't contain policy tags.</td> |
| 78 | + * <td> |
| 79 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 80 | + * <ul> |
| 81 | + * <li>createTaxonomy(CreateTaxonomyRequest request) |
| 82 | + * </ul> |
| 83 | + * <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> |
| 84 | + * <ul> |
| 85 | + * <li>createTaxonomy(LocationName parent, Taxonomy taxonomy) |
| 86 | + * <li>createTaxonomy(String parent, Taxonomy taxonomy) |
| 87 | + * </ul> |
| 88 | + * <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> |
| 89 | + * <ul> |
| 90 | + * <li>createTaxonomyCallable() |
| 91 | + * </ul> |
| 92 | + * </td> |
| 93 | + * </tr> |
| 94 | + * <tr> |
| 95 | + * <td>DeleteTaxonomy</td> |
| 96 | + * <td><p> Deletes a taxonomy, including all policy tags in this taxonomy, their associated policies, and the policy tags references from BigQuery columns.</td> |
| 97 | + * <td> |
| 98 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 99 | + * <ul> |
| 100 | + * <li>deleteTaxonomy(DeleteTaxonomyRequest request) |
| 101 | + * </ul> |
| 102 | + * <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> |
| 103 | + * <ul> |
| 104 | + * <li>deleteTaxonomy(TaxonomyName name) |
| 105 | + * <li>deleteTaxonomy(String name) |
| 106 | + * </ul> |
| 107 | + * <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> |
| 108 | + * <ul> |
| 109 | + * <li>deleteTaxonomyCallable() |
| 110 | + * </ul> |
| 111 | + * </td> |
| 112 | + * </tr> |
| 113 | + * <tr> |
| 114 | + * <td>UpdateTaxonomy</td> |
| 115 | + * <td><p> Updates a taxonomy, including its display name, description, and activated policy types.</td> |
| 116 | + * <td> |
| 117 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 118 | + * <ul> |
| 119 | + * <li>updateTaxonomy(UpdateTaxonomyRequest request) |
| 120 | + * </ul> |
| 121 | + * <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> |
| 122 | + * <ul> |
| 123 | + * <li>updateTaxonomy(Taxonomy taxonomy) |
| 124 | + * </ul> |
| 125 | + * <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> |
| 126 | + * <ul> |
| 127 | + * <li>updateTaxonomyCallable() |
| 128 | + * </ul> |
| 129 | + * </td> |
| 130 | + * </tr> |
| 131 | + * <tr> |
| 132 | + * <td>ListTaxonomies</td> |
| 133 | + * <td><p> Lists all taxonomies in a project in a particular location that you have a permission to view.</td> |
| 134 | + * <td> |
| 135 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 136 | + * <ul> |
| 137 | + * <li>listTaxonomies(ListTaxonomiesRequest request) |
| 138 | + * </ul> |
| 139 | + * <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> |
| 140 | + * <ul> |
| 141 | + * <li>listTaxonomies(LocationName parent) |
| 142 | + * <li>listTaxonomies(String parent) |
| 143 | + * </ul> |
| 144 | + * <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> |
| 145 | + * <ul> |
| 146 | + * <li>listTaxonomiesPagedCallable() |
| 147 | + * <li>listTaxonomiesCallable() |
| 148 | + * </ul> |
| 149 | + * </td> |
| 150 | + * </tr> |
| 151 | + * <tr> |
| 152 | + * <td>GetTaxonomy</td> |
| 153 | + * <td><p> Gets a taxonomy.</td> |
| 154 | + * <td> |
| 155 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 156 | + * <ul> |
| 157 | + * <li>getTaxonomy(GetTaxonomyRequest request) |
| 158 | + * </ul> |
| 159 | + * <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> |
| 160 | + * <ul> |
| 161 | + * <li>getTaxonomy(TaxonomyName name) |
| 162 | + * <li>getTaxonomy(String name) |
| 163 | + * </ul> |
| 164 | + * <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> |
| 165 | + * <ul> |
| 166 | + * <li>getTaxonomyCallable() |
| 167 | + * </ul> |
| 168 | + * </td> |
| 169 | + * </tr> |
| 170 | + * <tr> |
| 171 | + * <td>CreatePolicyTag</td> |
| 172 | + * <td><p> Creates a policy tag in a taxonomy.</td> |
| 173 | + * <td> |
| 174 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 175 | + * <ul> |
| 176 | + * <li>createPolicyTag(CreatePolicyTagRequest request) |
| 177 | + * </ul> |
| 178 | + * <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> |
| 179 | + * <ul> |
| 180 | + * <li>createPolicyTag(TaxonomyName parent, PolicyTag policyTag) |
| 181 | + * <li>createPolicyTag(String parent, PolicyTag policyTag) |
| 182 | + * </ul> |
| 183 | + * <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> |
| 184 | + * <ul> |
| 185 | + * <li>createPolicyTagCallable() |
| 186 | + * </ul> |
| 187 | + * </td> |
| 188 | + * </tr> |
| 189 | + * <tr> |
| 190 | + * <td>DeletePolicyTag</td> |
| 191 | + * <td><p> Deletes a policy tag together with the following: |
| 192 | + * <ul> |
| 193 | + * <li> All of its descendant policy tags, if any |
| 194 | + * <li> Policies associated with the policy tag and its descendants |
| 195 | + * <li> References from BigQuery table schema of the policy tag and its descendants |
| 196 | + * </ul></td> |
| 197 | + * <td> |
| 198 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 199 | + * <ul> |
| 200 | + * <li>deletePolicyTag(DeletePolicyTagRequest request) |
| 201 | + * </ul> |
| 202 | + * <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> |
| 203 | + * <ul> |
| 204 | + * <li>deletePolicyTag(PolicyTagName name) |
| 205 | + * <li>deletePolicyTag(String name) |
| 206 | + * </ul> |
| 207 | + * <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> |
| 208 | + * <ul> |
| 209 | + * <li>deletePolicyTagCallable() |
| 210 | + * </ul> |
| 211 | + * </td> |
| 212 | + * </tr> |
| 213 | + * <tr> |
| 214 | + * <td>UpdatePolicyTag</td> |
| 215 | + * <td><p> Updates a policy tag, including its display name, description, and parent policy tag.</td> |
| 216 | + * <td> |
| 217 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 218 | + * <ul> |
| 219 | + * <li>updatePolicyTag(UpdatePolicyTagRequest request) |
| 220 | + * </ul> |
| 221 | + * <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> |
| 222 | + * <ul> |
| 223 | + * <li>updatePolicyTag(PolicyTag policyTag) |
| 224 | + * </ul> |
| 225 | + * <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> |
| 226 | + * <ul> |
| 227 | + * <li>updatePolicyTagCallable() |
| 228 | + * </ul> |
| 229 | + * </td> |
| 230 | + * </tr> |
| 231 | + * <tr> |
| 232 | + * <td>ListPolicyTags</td> |
| 233 | + * <td><p> Lists all policy tags in a taxonomy.</td> |
| 234 | + * <td> |
| 235 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 236 | + * <ul> |
| 237 | + * <li>listPolicyTags(ListPolicyTagsRequest request) |
| 238 | + * </ul> |
| 239 | + * <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> |
| 240 | + * <ul> |
| 241 | + * <li>listPolicyTags(TaxonomyName parent) |
| 242 | + * <li>listPolicyTags(String parent) |
| 243 | + * </ul> |
| 244 | + * <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> |
| 245 | + * <ul> |
| 246 | + * <li>listPolicyTagsPagedCallable() |
| 247 | + * <li>listPolicyTagsCallable() |
| 248 | + * </ul> |
| 249 | + * </td> |
| 250 | + * </tr> |
| 251 | + * <tr> |
| 252 | + * <td>GetPolicyTag</td> |
| 253 | + * <td><p> Gets a policy tag.</td> |
| 254 | + * <td> |
| 255 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 256 | + * <ul> |
| 257 | + * <li>getPolicyTag(GetPolicyTagRequest request) |
| 258 | + * </ul> |
| 259 | + * <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> |
| 260 | + * <ul> |
| 261 | + * <li>getPolicyTag(PolicyTagName name) |
| 262 | + * <li>getPolicyTag(String name) |
| 263 | + * </ul> |
| 264 | + * <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> |
| 265 | + * <ul> |
| 266 | + * <li>getPolicyTagCallable() |
| 267 | + * </ul> |
| 268 | + * </td> |
| 269 | + * </tr> |
| 270 | + * <tr> |
| 271 | + * <td>GetIamPolicy</td> |
| 272 | + * <td><p> Gets the IAM policy for a policy tag or a taxonomy.</td> |
| 273 | + * <td> |
| 274 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 275 | + * <ul> |
| 276 | + * <li>getIamPolicy(GetIamPolicyRequest request) |
| 277 | + * </ul> |
| 278 | + * <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> |
| 279 | + * <ul> |
| 280 | + * <li>getIamPolicyCallable() |
| 281 | + * </ul> |
| 282 | + * </td> |
| 283 | + * </tr> |
| 284 | + * <tr> |
| 285 | + * <td>SetIamPolicy</td> |
| 286 | + * <td><p> Sets the IAM policy for a policy tag or a taxonomy.</td> |
| 287 | + * <td> |
| 288 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 289 | + * <ul> |
| 290 | + * <li>setIamPolicy(SetIamPolicyRequest request) |
| 291 | + * </ul> |
| 292 | + * <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> |
| 293 | + * <ul> |
| 294 | + * <li>setIamPolicyCallable() |
| 295 | + * </ul> |
| 296 | + * </td> |
| 297 | + * </tr> |
| 298 | + * <tr> |
| 299 | + * <td>TestIamPermissions</td> |
| 300 | + * <td><p> Returns your permissions on a specified policy tag or taxonomy.</td> |
| 301 | + * <td> |
| 302 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 303 | + * <ul> |
| 304 | + * <li>testIamPermissions(TestIamPermissionsRequest request) |
| 305 | + * </ul> |
| 306 | + * <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> |
| 307 | + * <ul> |
| 308 | + * <li>testIamPermissionsCallable() |
| 309 | + * </ul> |
| 310 | + * </td> |
| 311 | + * </tr> |
| 312 | + * </tr> |
| 313 | + * </table> |
82 | 314 | * |
83 | 315 | * <p>See the individual methods for example code. |
84 | 316 | * |
|
0 commit comments