2022-10-28
▼ ▲ batch.projects.locations.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations
Path : v1/{+name}/locations
Parameters :
name
Required : Yes
Location : path
Type : string
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
pageToken
Location : query
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Type : string
pageSize
Type : integer
Format : int32
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
filter
Type : string
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
Parameter Order : name
HTTP Method : GET
Description : Lists information about the supported locations for this service.
▼ ▲ batch.projects.locations.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Parameters :
name
Type : string
Description : Resource name for the location.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Gets information about a location.
HTTP Method : GET
▼ ▲ batch.projects.locations.state.report
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Description : Required. Format: projects/{project}/locations/{location} {project} should be a project number.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/state:report
Parameter Order : parent
Description : Report agent's state, e.g. agent status and tasks information
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/state:report
HTTP Method : POST
▼ ▲ batch.projects.locations.tasks.setIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
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.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tasks/{tasksId}:setIamPolicy
Parameter Order : resource
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/tasks/[^/]+$
Required : Yes
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
Type : string
▼ ▲ batch.projects.locations.tasks.testIamPermissions
Parameters :
resource
Required : Yes
Location : path
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/[^/]+/tasks/[^/]+$
Type : string
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tasks/{tasksId}: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.
Path : v1/{+resource}:testIamPermissions
▼ ▲ batch.projects.locations.tasks.getIamPolicy
Path : v1/{+resource}:getIamPolicy
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.
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/tasks/[^/]+$
Required : Yes
Type : string
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
options.requestedPolicyVersion
Format : int32
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
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tasks/{tasksId}:getIamPolicy
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : resource
▼ ▲ batch.projects.locations.jobs.get
Parameter Order : name
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Description : Required. Job name.
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}
Description : Get a Job specified by its resource name.
▼ ▲ batch.projects.locations.jobs.getIamPolicy
Parameter Order : resource
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}: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.
Path : v1/{+resource}:getIamPolicy
Parameters :
resource
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Location : path
Type : string
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
Location : query
Type : integer
Format : int32
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).
▼ ▲ batch.projects.locations.jobs.testIamPermissions
HTTP Method : POST
Parameters :
resource
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Required : Yes
Location : path
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.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}: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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : resource
Path : v1/{+resource}:testIamPermissions
▼ ▲ batch.projects.locations.jobs.setIamPolicy
Parameter Order : resource
Path : v1/{+resource}:setIamPolicy
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.
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Type : string
Required : Yes
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.
HTTP Method : POST
▼ ▲ batch.projects.locations.jobs.create
Parameters :
parent
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}"
Type : string
jobId
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
Location : query
requestId
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
Location : query
Description : Create a Job.
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/jobs
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs
▼ ▲ batch.projects.locations.jobs.list
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs
Path : v1/{+parent}/jobs
Description : List all Jobs for a project within a region.
HTTP Method : GET
Parameters :
filter
Location : query
Type : string
Description : List filter.
pageToken
Description : Page token.
Location : query
Type : string
pageSize
Location : query
Type : integer
Format : int32
Description : Page size.
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Description : Parent path.
▼ ▲ batch.projects.locations.jobs.delete
Parameters :
requestId
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
Type : string
reason
Description : Optional. Reason for this deletion.
Location : query
Type : string
name
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Required : Yes
Location : path
Type : string
Description : Job name.
HTTP Method : DELETE
Path : v1/{+name}
Parameter Order : name
Description : Delete a Job.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}
▼ ▲ batch.projects.locations.jobs.taskGroups.tasks.list
Parameters :
filter
Description : Task filter, null filter matches all Tasks. Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING
Location : query
Type : string
parent
Required : Yes
Location : path
Type : string
Description : Required. Name of a TaskGroup from which Tasks are being requested. Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+/taskGroups/[^/]+$
pageSize
Description : Page size.
Format : int32
Type : integer
Location : query
pageToken
Description : Page token.
Type : string
Location : query
Parameter Order : parent
Description : List Tasks associated with a job.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/taskGroups/{taskGroupsId}/tasks
Path : v1/{+parent}/tasks
HTTP Method : GET
▼ ▲ batch.projects.locations.jobs.taskGroups.tasks.get
Path : v1/{+name}
Parameter Order : name
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+/taskGroups/[^/]+/tasks/[^/]+$
Description : Required. Task name.
Required : Yes
Type : string
Location : path
Description : Return a single Task.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}/taskGroups/{taskGroupsId}/tasks/{tasksId}
▼ ▲ batch.projects.locations.nodes.setIamPolicy
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.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/nodes/[^/]+$
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
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.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:setIamPolicy
Parameter Order : resource
▼ ▲ batch.projects.locations.nodes.getIamPolicy
HTTP Method : GET
Parameters :
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
resource
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.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/nodes/[^/]+$
Path : v1/{+resource}: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.
Parameter Order : resource
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:getIamPolicy
▼ ▲ batch.projects.locations.nodes.testIamPermissions
Path : v1/{+resource}: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.
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
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.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/nodes/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:testIamPermissions
▼ ▲ batch.projects.locations.operations.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`.
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Required : Yes
Type : string
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
▼ ▲ batch.projects.locations.operations.get
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Required : Yes
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
Parameter Order : name
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.
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ batch.projects.locations.operations.list
Parameters :
name
Description : The name of the operation's parent resource.
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
pageSize
Type : integer
Format : int32
Description : The standard list page size.
Location : query
filter
Description : The standard list filter.
Location : query
Type : string
pageToken
Location : query
Description : The standard list page token.
Type : string
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : GET
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.
Path : v1/{+name}/operations
▼ ▲ batch.projects.locations.operations.cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
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
Path : v1/{+name}:cancel
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource to be cancelled.
Location : path
Type : string
Parameter Order : name
HTTP Method : POST