2024-11-20
▼ ▲ parallelstore.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
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists information about the supported locations for this service.
▼ ▲ parallelstore.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.
▼ ▲ parallelstore.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`.
▼ ▲ parallelstore.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.
▼ ▲ parallelstore.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`.
▼ ▲ parallelstore.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`.
▼ ▲ parallelstore.projects.locations.instances.list
Path : v1/{+parent}/instances
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances
HTTP Method : GET
Parameters :
parent
Description : Required. The project and location for which to retrieve instance information, in the format `projects/{project_id}/locations/{location}`. To retrieve instance information for all locations, use "-" as the value of `{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. A token identifying a page of results the server should return.
Location : query
Type : string
filter
Description : Optional. Filtering results.
Location : query
Type : string
orderBy
Description : Optional. Hint for how to order the results.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists all instances in a given project and location.
▼ ▲ parallelstore.projects.locations.instances.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}
HTTP Method : GET
Parameters :
name
Description : Required. The instance resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`.
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single instance.
▼ ▲ parallelstore.projects.locations.instances.create
Path : v1/{+parent}/instances
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances
HTTP Method : POST
Parameters :
parent
Description : Required. The instance's project and location, in the format `projects/{project}/locations/{location}`. Locations map to Google Cloud zones; for example, `us-west1-b`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
instanceId
Description : Required. The name of the Parallelstore instance. * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location
Location : query
Type : string
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).
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a Parallelstore instance in a given project and location.
▼ ▲ parallelstore.projects.locations.instances.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The resource name of the instance, in the format `projects/{project}/locations/{location}/instances/{instance_id}`.
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. Mask of fields to update. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. At least one path must be supplied in this field. The fields specified in the update_mask are relative to the resource, not the full request.
Location : query
Type : string
Format : google-fieldmask
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).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates the parameters of a single instance.
▼ ▲ parallelstore.projects.locations.instances.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Name of the resource
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Location : path
Required : Yes
Type : string
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
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a single instance.
▼ ▲ parallelstore.projects.locations.instances.importData
Path : v1/{+name}:importData
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:importData
HTTP Method : POST
Parameters :
name
Description : Required. Name of the resource.
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Copies data from Cloud Storage to Parallelstore.
▼ ▲ parallelstore.projects.locations.instances.exportData
Path : v1/{+name}:exportData
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:exportData
HTTP Method : POST
Parameters :
name
Description : Required. Name of the resource.
Pattern : ^projects/[^/]+/locations/[^/]+/instances/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Copies data from Parallelstore to Cloud Storage.