2022-10-29
▼ ▲ batch.projects.locations.tasks.testIamPermissions
Path : v1/{+resource}:testIamPermissions
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : resource
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tasks/{tasksId}:testIamPermissions
HTTP Method : POST
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters :
resource
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/tasks/[^/]+$
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
▼ ▲ batch.projects.locations.tasks.setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
HTTP Method : POST
Path : v1/{+resource}:setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tasks/{tasksId}:setIamPolicy
Parameter Order : resource
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/tasks/[^/]+$
Required : Yes
Location : path
▼ ▲ batch.projects.locations.tasks.getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : resource
Parameters :
resource
Location : path
Required : Yes
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/tasks/[^/]+$
Type : string
options.requestedPolicyVersion
Type : integer
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format : int32
Location : query
Path : v1/{+resource}:getIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tasks/{tasksId}:getIamPolicy
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ batch.projects.locations.jobs.taskGroups.tasks.get
Description : Return a single Task.
Parameter Order : name
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+/taskGroups/[^/]+/tasks/[^/]+$
Description : Required. Task name.
Required : Yes
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/taskGroups/{taskGroupsId}/tasks/{tasksId}
Path : v1/{+name}
▼ ▲ batch.projects.locations.jobs.taskGroups.tasks.list
Path : v1/{+parent}/tasks
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/taskGroups/{taskGroupsId}/tasks
Description : List Tasks associated with a job.
HTTP Method : GET
Parameters :
filter
Location : query
Type : string
Description : Task filter, null filter matches all Tasks. Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING
pageSize
Format : int32
Location : query
Description : Page size.
Type : integer
parent
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+/taskGroups/[^/]+$
Description : Required. Name of a TaskGroup from which Tasks are being requested. Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"
pageToken
Location : query
Type : string
Description : Page token.
▼ ▲ batch.projects.locations.jobs.delete
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Delete a Job.
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}
Parameters :
requestId
Type : string
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
reason
Type : string
Location : query
Description : Optional. Reason for this deletion.
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Type : string
Location : path
Description : Job name.
Path : v1/{+name}
▼ ▲ batch.projects.locations.jobs.create
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
jobId
Location : query
Description : ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase characters, numbers and '-' are accepted. The '-' character cannot be the first or the last one. A system generated ID will be used if the field is not set. The job.name field in the request will be ignored and the created resource name of the Job will be "{parent}/jobs/{job_id}".
Type : string
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}"
Required : Yes
Type : string
Location : path
requestId
Location : query
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs
HTTP Method : POST
Path : v1/{+parent}/jobs
Description : Create a Job.
Parameter Order : parent
▼ ▲ batch.projects.locations.jobs.getIamPolicy
Parameters :
resource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Type : string
Required : Yes
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
options.requestedPolicyVersion
Format : int32
Type : integer
Location : query
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Path : v1/{+resource}:getIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:getIamPolicy
Parameter Order : resource
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
▼ ▲ batch.projects.locations.jobs.testIamPermissions
Path : v1/{+resource}:testIamPermissions
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:testIamPermissions
Parameter Order : resource
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameters :
resource
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Type : string
▼ ▲ batch.projects.locations.jobs.setIamPolicy
Path : v1/{+resource}:setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Parameter Order : resource
Parameters :
resource
Type : string
Location : path
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Required : Yes
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ batch.projects.locations.jobs.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}
Parameter Order : name
HTTP Method : GET
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Location : path
Description : Required. Job name.
Path : v1/{+name}
Description : Get a Job specified by its resource name.
▼ ▲ batch.projects.locations.jobs.list
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs
Path : v1/{+parent}/jobs
Parameter Order : parent
Description : List all Jobs for a project within a region.
Parameters :
pageToken
Description : Page token.
Location : query
Type : string
pageSize
Description : Page size.
Type : integer
Format : int32
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
Location : path
Description : Parent path.
filter
Description : List filter.
Location : query
Type : string
▼ ▲ batch.projects.locations.nodes.setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:setIamPolicy
Parameters :
resource
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/nodes/[^/]+$
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location : path
Parameter Order : resource
Path : v1/{+resource}:setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ batch.projects.locations.nodes.getIamPolicy
Parameter Order : resource
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
resource
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/nodes/[^/]+$
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location : path
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
HTTP Method : GET
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:getIamPolicy
Path : v1/{+resource}:getIamPolicy
▼ ▲ batch.projects.locations.nodes.testIamPermissions
Parameter Order : resource
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:testIamPermissions
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
HTTP Method : POST
Path : v1/{+resource}:testIamPermissions
Parameters :
resource
Required : Yes
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/nodes/[^/]+$
Type : string
Location : path
▼ ▲ batch.projects.locations.operations.get
Parameter Order : name
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation resource.
Required : Yes
Type : string
▼ ▲ batch.projects.locations.operations.delete
HTTP Method : DELETE
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Path : v1/{+name}
Parameters :
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ batch.projects.locations.operations.cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Parameter Order : name
Path : v1/{+name}:cancel
▼ ▲ batch.projects.locations.operations.list
Parameters :
filter
Type : string
Location : query
Description : The standard list filter.
pageSize
Type : integer
Location : query
Format : int32
Description : The standard list page size.
name
Description : The name of the operation's parent resource.
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
pageToken
Description : The standard list page token.
Type : string
Location : query
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
Parameter Order : name
Path : v1/{+name}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations
▼ ▲ batch.projects.locations.state.report
Parameter Order : parent
HTTP Method : POST
Path : v1/{+parent}/state:report
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/state:report
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Report agent's state, e.g. agent status and tasks information
Parameters :
parent
Description : Required. Format: projects/{project}/locations/{location} {project} should be a project number.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
▼ ▲ batch.projects.locations.list
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations
Parameters :
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location : query
Type : string
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Type : integer
Format : int32
Location : query
pageToken
Type : string
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
name
Required : Yes
Location : path
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Type : string
HTTP Method : GET
Path : v1/{+name}/locations
Description : Lists information about the supported locations for this service.
▼ ▲ batch.projects.locations.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Description : Resource name for the location.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Location : path
HTTP Method : GET
Description : Gets information about a location.