2025-04-09
▼ ▲ storagebatchoperations.projects.locations.list
Path : v1/{+name}/locations
Flat Path : v1/projects/{projectsId}/locations
HTTP Method : GET
Parameters :
name
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
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.
Location : query
Type : integer
Format : int32
pageToken
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
Type : string
extraLocationTypes
Description : Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
Location : query
Repeated : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists information about the supported locations for this service.
▼ ▲ storagebatchoperations.projects.locations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}
HTTP Method : GET
Parameters :
name
Description : Resource name for the location.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets information about a location.
▼ ▲ storagebatchoperations.projects.locations.operations.list
Path : v1/{+name}/operations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ storagebatchoperations.projects.locations.operations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : 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.
▼ ▲ storagebatchoperations.projects.locations.operations.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
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`.
▼ ▲ storagebatchoperations.projects.locations.operations.cancel
Path : v1/{+name}:cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: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
Parameter Order : name
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`.
▼ ▲ storagebatchoperations.projects.locations.jobs.list
Path : v1/{+parent}/jobs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs
HTTP Method : GET
Parameters :
parent
Description : Required. Format: projects/{project_id}/locations/global.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : Optional. Filters results as defined by https://google.aip.dev/160.
Location : query
Type : string
pageSize
Description : Optional. The list page size. default page size is 100.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The list page token.
Location : query
Type : string
orderBy
Description : Optional. Field to sort by. Supported fields are name, create_time.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists Jobs in a given project.
▼ ▲ storagebatchoperations.projects.locations.jobs.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}
HTTP Method : GET
Parameters :
name
Description : Required. `name` of the job to retrieve. Format: projects/{project_id}/locations/global/jobs/{job_id} .
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets a batch job.
▼ ▲ storagebatchoperations.projects.locations.jobs.create
Path : v1/{+parent}/jobs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs
HTTP Method : POST
Parameters :
parent
Description : Required. Value for parent.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
jobId
Description : Required. The optional `job_id` for this Job . If not specified, an id is generated. `job_id` should be no more than 128 characters and must include only characters available in DNS names, as defined by RFC-1123.
Location : query
Type : string
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same `request_id` will ignored for at least 60 minutes since the first request. 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
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a batch job.
▼ ▲ storagebatchoperations.projects.locations.jobs.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The `name` of the job to delete. Format: projects/{project_id}/locations/global/jobs/{job_id} .
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same `request_id` will ignored for at least 60 minutes since the first request. 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
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a batch job.
▼ ▲ storagebatchoperations.projects.locations.jobs.cancel
Path : v1/{+name}:cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/jobs/{jobsId}:cancel
HTTP Method : POST
Parameters :
name
Description : Required. The `name` of the job to cancel. Format: projects/{project_id}/locations/global/jobs/{job_id}.
Pattern : ^projects/[^/]+/locations/[^/]+/jobs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Cancels a batch job.