|
79 | 79 | * <p>Note: close() needs to be called on the SchemaServiceClient object to clean up resources such
|
80 | 80 | * as threads. In the example above, try-with-resources is used, which automatically calls close().
|
81 | 81 | *
|
82 |
| - * <p>The surface of this class includes several types of Java methods for each of the API's |
83 |
| - * methods: |
84 |
| - * |
85 |
| - * <ol> |
86 |
| - * <li>A "flattened" method. With this type of method, the fields of the request type have been |
87 |
| - * converted into function parameters. It may be the case that not all fields are available as |
88 |
| - * parameters, and not every API method will have a flattened method entry point. |
89 |
| - * <li>A "request object" method. This type of method only takes one parameter, a request object, |
90 |
| - * which must be constructed before the call. Not every API method will have a request object |
91 |
| - * method. |
92 |
| - * <li>A "callable" method. This type of method takes no parameters and returns an immutable API |
93 |
| - * callable object, which can be used to initiate calls to the service. |
94 |
| - * </ol> |
| 82 | + * <table> |
| 83 | + * <caption>Methods</caption> |
| 84 | + * <tr> |
| 85 | + * <th>Method</th> |
| 86 | + * <th>Description</th> |
| 87 | + * <th>Method Variants</th> |
| 88 | + * </tr> |
| 89 | + * <tr> |
| 90 | + * <td>CreateSchema</td> |
| 91 | + * <td><p> Creates a schema.</td> |
| 92 | + * <td> |
| 93 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 94 | + * <ul> |
| 95 | + * <li>createSchema(CreateSchemaRequest request) |
| 96 | + * </ul> |
| 97 | + * <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> |
| 98 | + * <ul> |
| 99 | + * <li>createSchema(ProjectName parent, Schema schema, String schemaId) |
| 100 | + * <li>createSchema(String parent, Schema schema, String schemaId) |
| 101 | + * </ul> |
| 102 | + * <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> |
| 103 | + * <ul> |
| 104 | + * <li>createSchemaCallable() |
| 105 | + * </ul> |
| 106 | + * </td> |
| 107 | + * </tr> |
| 108 | + * <tr> |
| 109 | + * <td>GetSchema</td> |
| 110 | + * <td><p> Gets a schema.</td> |
| 111 | + * <td> |
| 112 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 113 | + * <ul> |
| 114 | + * <li>getSchema(GetSchemaRequest request) |
| 115 | + * </ul> |
| 116 | + * <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> |
| 117 | + * <ul> |
| 118 | + * <li>getSchema(SchemaName name) |
| 119 | + * <li>getSchema(String name) |
| 120 | + * </ul> |
| 121 | + * <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> |
| 122 | + * <ul> |
| 123 | + * <li>getSchemaCallable() |
| 124 | + * </ul> |
| 125 | + * </td> |
| 126 | + * </tr> |
| 127 | + * <tr> |
| 128 | + * <td>ListSchemas</td> |
| 129 | + * <td><p> Lists schemas in a project.</td> |
| 130 | + * <td> |
| 131 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 132 | + * <ul> |
| 133 | + * <li>listSchemas(ListSchemasRequest request) |
| 134 | + * </ul> |
| 135 | + * <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> |
| 136 | + * <ul> |
| 137 | + * <li>listSchemas(ProjectName parent) |
| 138 | + * <li>listSchemas(String parent) |
| 139 | + * </ul> |
| 140 | + * <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> |
| 141 | + * <ul> |
| 142 | + * <li>listSchemasPagedCallable() |
| 143 | + * <li>listSchemasCallable() |
| 144 | + * </ul> |
| 145 | + * </td> |
| 146 | + * </tr> |
| 147 | + * <tr> |
| 148 | + * <td>ListSchemaRevisions</td> |
| 149 | + * <td><p> Lists all schema revisions for the named schema.</td> |
| 150 | + * <td> |
| 151 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 152 | + * <ul> |
| 153 | + * <li>listSchemaRevisions(ListSchemaRevisionsRequest request) |
| 154 | + * </ul> |
| 155 | + * <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> |
| 156 | + * <ul> |
| 157 | + * <li>listSchemaRevisions(SchemaName name) |
| 158 | + * <li>listSchemaRevisions(String name) |
| 159 | + * </ul> |
| 160 | + * <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> |
| 161 | + * <ul> |
| 162 | + * <li>listSchemaRevisionsPagedCallable() |
| 163 | + * <li>listSchemaRevisionsCallable() |
| 164 | + * </ul> |
| 165 | + * </td> |
| 166 | + * </tr> |
| 167 | + * <tr> |
| 168 | + * <td>CommitSchema</td> |
| 169 | + * <td><p> Commits a new schema revision to an existing schema.</td> |
| 170 | + * <td> |
| 171 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 172 | + * <ul> |
| 173 | + * <li>commitSchema(CommitSchemaRequest request) |
| 174 | + * </ul> |
| 175 | + * <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> |
| 176 | + * <ul> |
| 177 | + * <li>commitSchema(SchemaName name, Schema schema) |
| 178 | + * <li>commitSchema(String name, Schema schema) |
| 179 | + * </ul> |
| 180 | + * <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> |
| 181 | + * <ul> |
| 182 | + * <li>commitSchemaCallable() |
| 183 | + * </ul> |
| 184 | + * </td> |
| 185 | + * </tr> |
| 186 | + * <tr> |
| 187 | + * <td>RollbackSchema</td> |
| 188 | + * <td><p> Creates a new schema revision that is a copy of the provided revision_id.</td> |
| 189 | + * <td> |
| 190 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 191 | + * <ul> |
| 192 | + * <li>rollbackSchema(RollbackSchemaRequest request) |
| 193 | + * </ul> |
| 194 | + * <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> |
| 195 | + * <ul> |
| 196 | + * <li>rollbackSchema(SchemaName name, String revisionId) |
| 197 | + * <li>rollbackSchema(String name, String revisionId) |
| 198 | + * </ul> |
| 199 | + * <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> |
| 200 | + * <ul> |
| 201 | + * <li>rollbackSchemaCallable() |
| 202 | + * </ul> |
| 203 | + * </td> |
| 204 | + * </tr> |
| 205 | + * <tr> |
| 206 | + * <td>DeleteSchemaRevision</td> |
| 207 | + * <td><p> Deletes a specific schema revision.</td> |
| 208 | + * <td> |
| 209 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 210 | + * <ul> |
| 211 | + * <li>deleteSchemaRevision(DeleteSchemaRevisionRequest request) |
| 212 | + * </ul> |
| 213 | + * <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> |
| 214 | + * <ul> |
| 215 | + * <li>deleteSchemaRevision(SchemaName name, String revisionId) |
| 216 | + * <li>deleteSchemaRevision(String name, String revisionId) |
| 217 | + * </ul> |
| 218 | + * <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> |
| 219 | + * <ul> |
| 220 | + * <li>deleteSchemaRevisionCallable() |
| 221 | + * </ul> |
| 222 | + * </td> |
| 223 | + * </tr> |
| 224 | + * <tr> |
| 225 | + * <td>DeleteSchema</td> |
| 226 | + * <td><p> Deletes a schema.</td> |
| 227 | + * <td> |
| 228 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 229 | + * <ul> |
| 230 | + * <li>deleteSchema(DeleteSchemaRequest request) |
| 231 | + * </ul> |
| 232 | + * <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> |
| 233 | + * <ul> |
| 234 | + * <li>deleteSchema(SchemaName name) |
| 235 | + * <li>deleteSchema(String name) |
| 236 | + * </ul> |
| 237 | + * <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> |
| 238 | + * <ul> |
| 239 | + * <li>deleteSchemaCallable() |
| 240 | + * </ul> |
| 241 | + * </td> |
| 242 | + * </tr> |
| 243 | + * <tr> |
| 244 | + * <td>ValidateSchema</td> |
| 245 | + * <td><p> Validates a schema.</td> |
| 246 | + * <td> |
| 247 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 248 | + * <ul> |
| 249 | + * <li>validateSchema(ValidateSchemaRequest request) |
| 250 | + * </ul> |
| 251 | + * <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> |
| 252 | + * <ul> |
| 253 | + * <li>validateSchema(ProjectName parent, Schema schema) |
| 254 | + * <li>validateSchema(String parent, Schema schema) |
| 255 | + * </ul> |
| 256 | + * <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> |
| 257 | + * <ul> |
| 258 | + * <li>validateSchemaCallable() |
| 259 | + * </ul> |
| 260 | + * </td> |
| 261 | + * </tr> |
| 262 | + * <tr> |
| 263 | + * <td>ValidateMessage</td> |
| 264 | + * <td><p> Validates a message against a schema.</td> |
| 265 | + * <td> |
| 266 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 267 | + * <ul> |
| 268 | + * <li>validateMessage(ValidateMessageRequest request) |
| 269 | + * </ul> |
| 270 | + * <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> |
| 271 | + * <ul> |
| 272 | + * <li>validateMessageCallable() |
| 273 | + * </ul> |
| 274 | + * </td> |
| 275 | + * </tr> |
| 276 | + * <tr> |
| 277 | + * <td>SetIamPolicy</td> |
| 278 | + * <td><p> Sets the access control policy on the specified resource. Replacesany existing policy. |
| 279 | + * <p> Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.</td> |
| 280 | + * <td> |
| 281 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 282 | + * <ul> |
| 283 | + * <li>setIamPolicy(SetIamPolicyRequest request) |
| 284 | + * </ul> |
| 285 | + * <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> |
| 286 | + * <ul> |
| 287 | + * <li>setIamPolicyCallable() |
| 288 | + * </ul> |
| 289 | + * </td> |
| 290 | + * </tr> |
| 291 | + * <tr> |
| 292 | + * <td>GetIamPolicy</td> |
| 293 | + * <td><p> Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.</td> |
| 294 | + * <td> |
| 295 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 296 | + * <ul> |
| 297 | + * <li>getIamPolicy(GetIamPolicyRequest request) |
| 298 | + * </ul> |
| 299 | + * <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> |
| 300 | + * <ul> |
| 301 | + * <li>getIamPolicyCallable() |
| 302 | + * </ul> |
| 303 | + * </td> |
| 304 | + * </tr> |
| 305 | + * <tr> |
| 306 | + * <td>TestIamPermissions</td> |
| 307 | + * <td><p> Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. |
| 308 | + * <p> Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.</td> |
| 309 | + * <td> |
| 310 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 311 | + * <ul> |
| 312 | + * <li>testIamPermissions(TestIamPermissionsRequest request) |
| 313 | + * </ul> |
| 314 | + * <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> |
| 315 | + * <ul> |
| 316 | + * <li>testIamPermissionsCallable() |
| 317 | + * </ul> |
| 318 | + * </td> |
| 319 | + * </tr> |
| 320 | + * </table> |
95 | 321 | *
|
96 | 322 | * <p>See the individual methods for example code.
|
97 | 323 | *
|
|
0 commit comments