|
67 | 67 | * <p>Note: close() needs to be called on the BatchServiceClient object to clean up resources such |
68 | 68 | * as threads. In the example above, try-with-resources is used, which automatically calls close(). |
69 | 69 | * |
70 | | - * <p>The surface of this class includes several types of Java methods for each of the API's |
71 | | - * methods: |
72 | | - * |
73 | | - * <ol> |
74 | | - * <li>A "flattened" method. With this type of method, the fields of the request type have been |
75 | | - * converted into function parameters. It may be the case that not all fields are available as |
76 | | - * parameters, and not every API method will have a flattened method entry point. |
77 | | - * <li>A "request object" method. This type of method only takes one parameter, a request object, |
78 | | - * which must be constructed before the call. Not every API method will have a request object |
79 | | - * method. |
80 | | - * <li>A "callable" method. This type of method takes no parameters and returns an immutable API |
81 | | - * callable object, which can be used to initiate calls to the service. |
82 | | - * </ol> |
| 70 | + * <table> |
| 71 | + * <tr> |
| 72 | + * <th>Method</th> |
| 73 | + * <th>Description</th> |
| 74 | + * <th>Method Variants</th> |
| 75 | + * <tr> |
| 76 | + * <td>CreateJob</td> |
| 77 | + * <td><p> Create a Job.</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>createJob(CreateJobRequest 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>createJob(LocationName parent, Job job, String jobId) |
| 86 | + * <li>createJob(String parent, Job job, String jobId) |
| 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>createJobCallable() |
| 91 | + * </ul> |
| 92 | + * </td> |
| 93 | + * </tr> |
| 94 | + * <tr> |
| 95 | + * <td>GetJob</td> |
| 96 | + * <td><p> Get a Job specified by its resource name.</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>getJob(GetJobRequest 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>getJob(JobName name) |
| 105 | + * <li>getJob(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>getJobCallable() |
| 110 | + * </ul> |
| 111 | + * </td> |
| 112 | + * </tr> |
| 113 | + * <tr> |
| 114 | + * <td>DeleteJob</td> |
| 115 | + * <td><p> Delete a Job.</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>deleteJobAsync(DeleteJobRequest request) |
| 120 | + * </ul> |
| 121 | + * <p>Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.</p> |
| 122 | + * <ul> |
| 123 | + * <li>deleteJobAsync(String name) |
| 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>deleteJobOperationCallable() |
| 128 | + * <li>deleteJobCallable() |
| 129 | + * </ul> |
| 130 | + * </td> |
| 131 | + * </tr> |
| 132 | + * <tr> |
| 133 | + * <td>ListJobs</td> |
| 134 | + * <td><p> List all Jobs for a project within a region.</td> |
| 135 | + * <td> |
| 136 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 137 | + * <ul> |
| 138 | + * <li>listJobs(ListJobsRequest request) |
| 139 | + * </ul> |
| 140 | + * <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> |
| 141 | + * <ul> |
| 142 | + * <li>listJobs(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>listJobsPagedCallable() |
| 147 | + * <li>listJobsCallable() |
| 148 | + * </ul> |
| 149 | + * </td> |
| 150 | + * </tr> |
| 151 | + * <tr> |
| 152 | + * <td>GetTask</td> |
| 153 | + * <td><p> Return a single Task.</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>getTask(GetTaskRequest 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>getTask(TaskName name) |
| 162 | + * <li>getTask(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>getTaskCallable() |
| 167 | + * </ul> |
| 168 | + * </td> |
| 169 | + * </tr> |
| 170 | + * <tr> |
| 171 | + * <td>ListTasks</td> |
| 172 | + * <td><p> List Tasks associated with a job.</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>listTasks(ListTasksRequest 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>listTasks(TaskGroupName parent) |
| 181 | + * <li>listTasks(String parent) |
| 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>listTasksPagedCallable() |
| 186 | + * <li>listTasksCallable() |
| 187 | + * </ul> |
| 188 | + * </td> |
| 189 | + * </tr> |
| 190 | + * <tr> |
| 191 | + * <td>ListLocations</td> |
| 192 | + * <td><p> Lists information about the supported locations for this service.</td> |
| 193 | + * <td> |
| 194 | + * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
| 195 | + * <ul> |
| 196 | + * <li>listLocations(ListLocationsRequest request) |
| 197 | + * </ul> |
| 198 | + * <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> |
| 199 | + * <ul> |
| 200 | + * <li>listLocationsPagedCallable() |
| 201 | + * <li>listLocationsCallable() |
| 202 | + * </ul> |
| 203 | + * </td> |
| 204 | + * </tr> |
| 205 | + * <tr> |
| 206 | + * <td>GetLocation</td> |
| 207 | + * <td><p> Gets information about a location.</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>getLocation(GetLocationRequest request) |
| 212 | + * </ul> |
| 213 | + * <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> |
| 214 | + * <ul> |
| 215 | + * <li>getLocationCallable() |
| 216 | + * </ul> |
| 217 | + * </td> |
| 218 | + * </tr> |
| 219 | + * </tr> |
| 220 | + * </table> |
83 | 221 | * |
84 | 222 | * <p>See the individual methods for example code. |
85 | 223 | * |
|
![gcf-owl-bot[bot]](https://avatars.githubusercontent.com/in/99011?v=4&size=40){kind=avatar}
0 commit comments