2023-09-13
▼ ▲ rapidmigrationassessment.projects.locations.operations.cancel
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
Path: v1/{+name}:cancel
Parameters:
name
Location: path
Description: The name of the operation resource to be cancelled.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
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`.
▼ ▲ rapidmigrationassessment.projects.locations.operations.get
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}
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Description: The name of the operation resource.
Location: path
▼ ▲ rapidmigrationassessment.projects.locations.operations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameters:
pageToken
Description: The standard list page token.
Location: query
Type: string
filter
Description: The standard list filter.
Location: query
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Description: The name of the operation's parent resource.
Required: Yes
pageSize
Location: query
Type: integer
Description: The standard list page size.
Format: int32
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
Path: v1/{+name}/operations
▼ ▲ rapidmigrationassessment.projects.locations.operations.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Path: v1/{+name}
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Location: path
Description: The name of the operation resource to be deleted.
HTTP Method: DELETE
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`.
▼ ▲ rapidmigrationassessment.projects.locations.collectors.list
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collectors
Description: Lists Collectors in a given project and location.
Path: v1/{+parent}/collectors
Parameters:
orderBy
Description: Hint for how to order the results.
Type: string
Location: query
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Required. Parent value for ListCollectorsRequest.
pageSize
Location: query
Type: integer
Description: Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Format: int32
pageToken
Description: A token identifying a page of results the server should return.
Type: string
Location: query
filter
Type: string
Description: Filtering results.
Location: query
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ rapidmigrationassessment.projects.locations.collectors.delete
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collectors/{collectorsId}
Parameters:
name
Description: Required. Name of the resource.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/collectors/[^/]+$
Location: path
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 the 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
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion thorugh producer api.
Path: v1/{+name}
HTTP Method: DELETE
▼ ▲ rapidmigrationassessment.projects.locations.collectors.create
Parameters:
collectorId
Type: string
Location: query
Description: Required. Id of the requesting object.
requestId
Description: Optional. An optional request ID to identify requests.
Type: string
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Description: Required. Name of the parent (project+location).
Location: path
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collectors
HTTP Method: POST
Description: Create a Collector to manage the on-prem appliance which collects information about Customer assets.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/collectors
▼ ▲ rapidmigrationassessment.projects.locations.collectors.resume
Description: Resumes the given collector.
HTTP Method: POST
Path: v1/{+name}:resume
Parameter Order: name
Parameters:
name
Description: Required. Name of the resource.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/collectors/[^/]+$
Location: path
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collectors/{collectorsId}:resume
▼ ▲ rapidmigrationassessment.projects.locations.collectors.pause
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}:pause
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collectors/{collectorsId}:pause
HTTP Method: POST
Description: Pauses the given collector.
Parameters:
name
Type: string
Location: path
Description: Required. Name of the resource.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/collectors/[^/]+$
▼ ▲ rapidmigrationassessment.projects.locations.collectors.patch
Parameters:
updateMask
Location: query
Description: Required. Field mask is used to specify the fields to be overwritten in the Collector resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
Format: google-fieldmask
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/collectors/[^/]+$
Location: path
Type: string
Required: Yes
Description: name of resource.
requestId
Type: string
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 the 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).
Parameter Order: name
Description: Updates the parameters of a single Collector.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collectors/{collectorsId}
HTTP Method: PATCH
Path: v1/{+name}
▼ ▲ rapidmigrationassessment.projects.locations.collectors.get
Description: Gets details of a single Collector.
Parameters:
name
Description: Required. Name of the resource.
Pattern: ^projects/[^/]+/locations/[^/]+/collectors/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collectors/{collectorsId}
HTTP Method: GET
▼ ▲ rapidmigrationassessment.projects.locations.collectors.register
Path: v1/{+name}:register
HTTP Method: POST
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Registers the given collector.
Parameters:
name
Description: Required. Name of the resource.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/collectors/[^/]+$
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collectors/{collectorsId}:register
▼ ▲ rapidmigrationassessment.projects.locations.annotations.create
Description: Creates an Annotation
Path: v1/{+parent}/annotations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
Description: Required. Name of the parent (project+location).
Required: Yes
requestId
Type: string
Location: query
Description: Optional. An optional request ID to identify requests.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/annotations
HTTP Method: POST
Parameter Order: parent
▼ ▲ rapidmigrationassessment.projects.locations.annotations.get
Description: Gets details of a single Annotation.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1/{+name}
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/annotations/[^/]+$
Description: Required. Name of the resource.
Required: Yes
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/annotations/{annotationsId}
▼ ▲ rapidmigrationassessment.projects.locations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Resource name for the location.
Type: string
Required: Yes
Location: path
Description: Gets information about a location.
Parameter Order: name
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
▼ ▲ rapidmigrationassessment.projects.locations.list
Description: Lists information about the supported locations for this service.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations
HTTP Method: GET
Path: v1/{+name}/locations
Parameters:
pageSize
Format: int32
Type: integer
Location: query
Description: The maximum number of results to return. If not set, the service selects a default.
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+$
Description: The resource that owns the locations collection, if applicable.
Location: path
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
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).
Type: string
Location: query
Parameter Order: name