Regenerated library to pick up latest schema changes

Author: petemoore

src/main/java/org/mozilla/taskcluster/client/auth/Auth.java

@@ -109,6 +109,9 @@ public CallSummary<EmptyPayload, GetClientResponse> client(String clientId) thro
      * 
      * The caller's scopes must satisfy `scopes`.
      *
+     * Required scopes:
+     *   * auth:create-client:<clientId>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#createClient
      */
     public CallSummary<CreateClientRequest, CreateClientResponse> createClient(String clientId, CreateClientRequest payload) throws APICallFailure {
@@ -123,6 +126,9 @@ public CallSummary<CreateClientRequest, CreateClientResponse> createClient(Strin
      * There is no way to retrieve an existing `accessToken`, so if you loose it
      * you must reset the accessToken to acquire it again.
      *
+     * Required scopes:
+     *   * auth:reset-access-token:<clientId>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#resetAccessToken
      */
     public CallSummary<EmptyPayload, CreateClientResponse> resetAccessToken(String clientId) throws APICallFailure {
@@ -136,6 +142,9 @@ public CallSummary<EmptyPayload, CreateClientResponse> resetAccessToken(String c
      * If no scopes are given in the request, the client's scopes remain
      * unchanged
      *
+     * Required scopes:
+     *   * auth:update-client:<clientId>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#updateClient
      */
     public CallSummary<CreateClientRequest, GetClientResponse> updateClient(String clientId, CreateClientRequest payload) throws APICallFailure {
@@ -149,6 +158,9 @@ public CallSummary<CreateClientRequest, GetClientResponse> updateClient(String c
      * This is typically used by identity providers to re-enable clients that
      * had been disabled when the corresponding identity's scopes changed.
      *
+     * Required scopes:
+     *   * auth:enable-client:<clientId>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#enableClient
      */
     public CallSummary<EmptyPayload, GetClientResponse> enableClient(String clientId) throws APICallFailure {
@@ -161,6 +173,9 @@ public CallSummary<EmptyPayload, GetClientResponse> enableClient(String clientId
      * This is typically used by identity providers to disable clients when the
      * corresponding identity's scopes no longer satisfy the client's scopes.
      *
+     * Required scopes:
+     *   * auth:disable-client:<clientId>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#disableClient
      */
     public CallSummary<EmptyPayload, GetClientResponse> disableClient(String clientId) throws APICallFailure {
@@ -171,6 +186,9 @@ public CallSummary<EmptyPayload, GetClientResponse> disableClient(String clientI
      * Delete a client, please note that any roles related to this client must
      * be deleted independently.
      *
+     * Required scopes:
+     *   * auth:delete-client:<clientId>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#deleteClient
      */
     public CallSummary<EmptyPayload, EmptyPayload> deleteClient(String clientId) throws APICallFailure {
@@ -205,6 +223,9 @@ public CallSummary<EmptyPayload, GetRoleResponse> role(String roleId) throws API
      * If there already exists a role with the same `roleId` this operation
      * will fail. Use `updateRole` to modify an existing role.
      *
+     * Required scopes:
+     *   * auth:create-role:<roleId>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#createRole
      */
     public CallSummary<CreateRoleRequest, GetRoleResponse> createRole(String roleId, CreateRoleRequest payload) throws APICallFailure {
@@ -217,6 +238,9 @@ public CallSummary<CreateRoleRequest, GetRoleResponse> createRole(String roleId,
      * The caller's scopes must satisfy all of the new scopes being added, but
      * need not satisfy all of the client's existing scopes.
      *
+     * Required scopes:
+     *   * auth:update-role:<roleId>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#updateRole
      */
     public CallSummary<CreateRoleRequest, GetRoleResponse> updateRole(String roleId, CreateRoleRequest payload) throws APICallFailure {
@@ -227,6 +251,9 @@ public CallSummary<CreateRoleRequest, GetRoleResponse> updateRole(String roleId,
      * Delete a role. This operation will succeed regardless of whether or not
      * the role exists.
      *
+     * Required scopes:
+     *   * auth:delete-role:<roleId>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#deleteRole
      */
     public CallSummary<EmptyPayload, EmptyPayload> deleteRole(String roleId) throws APICallFailure {
@@ -308,6 +335,9 @@ public CallSummary<EmptyPayload, SetOfScopes> currentScopes() throws APICallFail
      * access to `my-folder/file.txt` as expected, but also to `my-folder.txt`,
      * which may not be intended.
      *
+     * Required scopes:
+     *   * auth:aws-s3:<level>:<bucket>/<prefix>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#awsS3Credentials
      */
     public CallSummary<EmptyPayload, AWSS3CredentialsResponse> awsS3Credentials(String level, String bucket, String prefix) throws APICallFailure {
@@ -319,6 +349,9 @@ public CallSummary<EmptyPayload, AWSS3CredentialsResponse> awsS3Credentials(Stri
      * Table Storage table.  Note, this will create the table, if it doesn't
      * already exist.
      *
+     * Required scopes:
+     *   * auth:azure-table-access:<account>/<table>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#azureTableSAS
      */
     public CallSummary<EmptyPayload, AzureSharedAccessSignatureResponse> azureTableSAS(String account, String table) throws APICallFailure {
@@ -334,6 +367,9 @@ public CallSummary<EmptyPayload, AzureSharedAccessSignatureResponse> azureTableS
      * initial team configured for this component. Contact a Sentry admin
      * to have the project transferred to a team you have access to if needed
      *
+     * Required scopes:
+     *   * auth:sentry:<project>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#sentryDSN
      */
     public CallSummary<EmptyPayload, SentryDSNResponse> sentryDSN(String project) throws APICallFailure {
@@ -345,6 +381,9 @@ public CallSummary<EmptyPayload, SentryDSNResponse> sentryDSN(String project) th
      * 
      * The token is valid for 24 hours, clients should refresh after expiration.
      *
+     * Required scopes:
+     *   * auth:statsum:<project>
+     *
      * See https://docs.taskcluster.net/reference/platform/auth/api-docs#statsumToken
      */
     public CallSummary<EmptyPayload, StatsumTokenResponse> statsumToken(String project) throws APICallFailure {

src/main/java/org/mozilla/taskcluster/client/awsprovisioner/AwsProvisioner.java

@@ -106,6 +106,9 @@ public CallSummary<EmptyPayload, WorkerTypeSummary[]> listWorkerTypeSummaries()
      * will be used to generate a set of temporary credentials available with
      * the other secrets.
      *
+     * Required scopes:
+     *   * aws-provisioner:manage-worker-type:<workerType>
+     *
      * See https://docs.taskcluster.net/reference/core/aws-provisioner/api-docs#createWorkerType
      */
     public CallSummary<CreateWorkerTypeRequest, GetWorkerTypeResponse> createWorkerType(String workerType, CreateWorkerTypeRequest payload) throws APICallFailure {
@@ -125,6 +128,9 @@ public CallSummary<CreateWorkerTypeRequest, GetWorkerTypeResponse> createWorkerT
      * Otherwise, all input requirements and actions are the same as the
      * create method.
      *
+     * Required scopes:
+     *   * aws-provisioner:manage-worker-type:<workerType>
+     *
      * See https://docs.taskcluster.net/reference/core/aws-provisioner/api-docs#updateWorkerType
      */
     public CallSummary<CreateWorkerTypeRequest, GetWorkerTypeResponse> updateWorkerType(String workerType, CreateWorkerTypeRequest payload) throws APICallFailure {
@@ -138,6 +144,10 @@ public CallSummary<CreateWorkerTypeRequest, GetWorkerTypeResponse> updateWorkerT
      * use the results of this method to submit date to the update
      * method.
      *
+     * Required scopes:
+     *   * aws-provisioner:view-worker-type:<workerType>, or
+     *   * aws-provisioner:manage-worker-type:<workerType>
+     *
      * See https://docs.taskcluster.net/reference/core/aws-provisioner/api-docs#workerType
      */
     public CallSummary<EmptyPayload, GetWorkerTypeResponse> workerType(String workerType) throws APICallFailure {
@@ -156,6 +166,9 @@ public CallSummary<EmptyPayload, GetWorkerTypeResponse> workerType(String worker
      * or you could theoretically set maxCapacity to 0, though, this is
      * not a supported or tested action
      *
+     * Required scopes:
+     *   * aws-provisioner:manage-worker-type:<workerType>
+     *
      * See https://docs.taskcluster.net/reference/core/aws-provisioner/api-docs#removeWorkerType
      */
     public CallSummary<EmptyPayload, EmptyPayload> removeWorkerType(String workerType) throws APICallFailure {
@@ -182,6 +195,9 @@ public CallSummary<EmptyPayload, String[]> listWorkerTypes() throws APICallFailu
      * This method is not ordinarily used in production; instead, the provisioner
      * creates a new secret directly for each spot bid.
      *
+     * Required scopes:
+     *   * aws-provisioner:create-secret
+     *
      * See https://docs.taskcluster.net/reference/core/aws-provisioner/api-docs#createSecret
      */
     public CallSummary<GetSecretRequest, EmptyPayload> createSecret(String token, GetSecretRequest payload) throws APICallFailure {
@@ -237,6 +253,10 @@ public CallSummary<EmptyPayload, EmptyPayload> removeSecret(String token) throws
      * 
      * **This API end-point is experimental and may be subject to change without warning.**
      *
+     * Required scopes:
+     *   * aws-provisioner:view-worker-type:<workerType>, or
+     *   * aws-provisioner:manage-worker-type:<workerType>
+     *
      * See https://docs.taskcluster.net/reference/core/aws-provisioner/api-docs#getLaunchSpecs
      */
     public CallSummary<EmptyPayload, Object> getLaunchSpecs(String workerType) throws APICallFailure {
@@ -250,6 +270,9 @@ public CallSummary<EmptyPayload, Object> getLaunchSpecs(String workerType) throw
      * in the provisioner.  The `summary` property contains an updated summary
      * similar to that returned from `listWorkerTypeSummaries`.
      *
+     * Required scopes:
+     *   * aws-provisioner:view-worker-type:<workerType>
+     *
      * See https://docs.taskcluster.net/reference/core/aws-provisioner/api-docs#state
      */
     public CallSummary<EmptyPayload, EmptyPayload> state(String workerType) throws APICallFailure {

src/main/java/org/mozilla/taskcluster/client/hooks/Hooks.java

@@ -112,6 +112,10 @@ public CallSummary<EmptyPayload, HookScheduleResponse> getHookSchedule(String ho
      * create the task.  That role must satisfy task.scopes as well as the
      * necessary scopes to add the task to the queue.
      *
+     * Required scopes:
+     *   * hooks:modify-hook:<hookGroupId>/<hookId>, and
+     *   * assume:hook-id:<hookGroupId>/<hookId>
+     *
      * See https://docs.taskcluster.net/reference/core/hooks/api-docs#createHook
      */
     public CallSummary<HookCreationRequest, HookDefinition> createHook(String hookGroupId, String hookId, HookCreationRequest payload) throws APICallFailure {
@@ -122,6 +126,10 @@ public CallSummary<HookCreationRequest, HookDefinition> createHook(String hookGr
      * This endpoint will update an existing hook.  All fields except
      * `hookGroupId` and `hookId` can be modified.
      *
+     * Required scopes:
+     *   * hooks:modify-hook:<hookGroupId>/<hookId>, and
+     *   * assume:hook-id:<hookGroupId>/<hookId>
+     *
      * See https://docs.taskcluster.net/reference/core/hooks/api-docs#updateHook
      */
     public CallSummary<HookCreationRequest, HookDefinition> updateHook(String hookGroupId, String hookId, HookCreationRequest payload) throws APICallFailure {
@@ -131,6 +139,9 @@ public CallSummary<HookCreationRequest, HookDefinition> updateHook(String hookGr
     /**
      * This endpoint will remove a hook definition.
      *
+     * Required scopes:
+     *   * hooks:modify-hook:<hookGroupId>/<hookId>
+     *
      * See https://docs.taskcluster.net/reference/core/hooks/api-docs#removeHook
      */
     public CallSummary<EmptyPayload, EmptyPayload> removeHook(String hookGroupId, String hookId) throws APICallFailure {

src/main/java/org/mozilla/taskcluster/client/index/Index.java

@@ -177,6 +177,9 @@ public CallSummary<ListTasksRequest, ListTasksResponse> listTasks(String namespa
      * Insert a task into the index. Please see the introduction above, for how
      * to index successfully completed tasks automatically, using custom routes.
      *
+     * Required scopes:
+     *   * index:insert-task:<namespace>
+     *
      * See https://docs.taskcluster.net/reference/core/index/api-docs#insertTask
      */
     public CallSummary<InsertTaskRequest, IndexedTaskResponse> insertTask(String namespace, InsertTaskRequest payload) throws APICallFailure {
@@ -188,6 +191,9 @@ public CallSummary<InsertTaskRequest, IndexedTaskResponse> insertTask(String nam
      * if no task existing for the given namespace, this API end-point respond
      * `404`.
      *
+     * Required scopes:
+     *   * queue:get-artifact:<name>
+     *
      * See https://docs.taskcluster.net/reference/core/index/api-docs#findArtifactFromTask
      */
     public CallSummary<EmptyPayload, EmptyPayload> findArtifactFromTask(String namespace, String name) throws APICallFailure {

src/main/java/org/mozilla/taskcluster/client/purgecache/PurgeCache.java

@@ -53,6 +53,9 @@ public PurgeCache() {
      * `provisionerId` and `workerType` in the routing-key. Workers should
      * be listening for this message and purge caches when they see it.
      *
+     * Required scopes:
+     *   * purge-cache:<provisionerId>/<workerType>:<cacheName>
+     *
      * See https://docs.taskcluster.net/reference/core/purge-cache/api-docs#purgeCache
      */
     public CallSummary<PurgeCacheRequest, EmptyPayload> purgeCache(String provisionerId, String workerType, PurgeCacheRequest payload) throws APICallFailure {