2023-04-02
▼ ▲ migrationcenter.projects.locations.reportConfigs.list
HTTP Method: GET
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/reportConfigs
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. Parent value for `ListReportConfigsRequest`.
filter
Type: string
Description: Filtering results.
Location: query
pageSize
Format: int32
Description: Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
orderBy
Location: query
Type: string
Description: Field to sort by. See https://google.aip.dev/132#ordering for more details.
pageToken
Location: query
Description: A token identifying a page of results the server should return.
Type: string
Parameter Order: parent
Path: v1alpha1/{+parent}/reportConfigs
Description: Lists ReportConfigs in a given project and location.
▼ ▲ migrationcenter.projects.locations.reportConfigs.create
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a report configuration.
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/reportConfigs
Parameter Order: parent
Parameters:
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. Value for parent.
reportConfigId
Type: string
Description: Required. User specified ID for the report config. It will become the last component of the report config name. The ID must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The ID must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
Location: query
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 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).
Location: query
Path: v1alpha1/{+parent}/reportConfigs
HTTP Method: POST
▼ ▲ migrationcenter.projects.locations.reportConfigs.delete
Description: Deletes a ReportConfig.
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId}
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 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
force
Location: query
Type: boolean
Description: Optional. If set to `true`, any child `Reports` of this entity will also be deleted. If set to `false`, the request only works if the resource has no children.
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/reportConfigs/[^/]+$
Required: Yes
Description: Required. Name of the resource.
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha1/{+name}
HTTP Method: DELETE
▼ ▲ migrationcenter.projects.locations.reportConfigs.get
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a single ReportConfig.
Path: v1alpha1/{+name}
HTTP Method: GET
Parameter Order: name
Parameters:
name
Description: Required. Name of the resource.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/reportConfigs/[^/]+$
Type: string
Required: Yes
▼ ▲ migrationcenter.projects.locations.reportConfigs.reports.list
Description: Lists Reports in a given ReportConfig.
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId}/reports
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Parameters:
orderBy
Type: string
Description: Field to sort by. See https://google.aip.dev/132#ordering for more details.
Location: query
parent
Location: path
Type: string
Description: Required. Parent value for `ListReportsRequest`.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/reportConfigs/[^/]+$
filter
Type: string
Description: Filtering results.
Location: query
view
Type: string
Description: Determines what information to retrieve for each Report.
Enum:
Enum Descriptions:
Location: query
pageSize
Location: query
Description: Requested page size. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default value.
Format: int32
Type: integer
pageToken
Location: query
Type: string
Description: A token identifying a page of results that the server should return.
Path: v1alpha1/{+parent}/reports
▼ ▲ migrationcenter.projects.locations.reportConfigs.reports.get
Parameters:
name
Required: Yes
Description: Required. Name of the resource.
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/reportConfigs/[^/]+/reports/[^/]+$
view
Location: query
Enum:
Type: string
Description: Determines what information to retrieve for the Report.
Enum Descriptions:
Parameter Order: name
Description: Gets details of a single Report.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId}/reports/{reportsId}
HTTP Method: GET
Path: v1alpha1/{+name}
▼ ▲ migrationcenter.projects.locations.reportConfigs.reports.delete
Description: Deletes a Report.
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId}/reports/{reportsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha1/{+name}
HTTP Method: DELETE
Parameter Order: name
Parameters:
name
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/reportConfigs/[^/]+/reports/[^/]+$
Type: string
Location: path
Description: Required. Name of the resource.
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 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
▼ ▲ migrationcenter.projects.locations.reportConfigs.reports.create
HTTP Method: POST
Path: v1alpha1/{+parent}/reports
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Description: Creates a report.
Parameters:
reportId
Description: Required. User specified id for the report. It will become the last component of the report name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. The id must match the regular expression: [a-z]([a-z0-9-]{0,61}[a-z0-9])?.
Location: query
Type: string
requestId
Location: query
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 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).
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/reportConfigs/[^/]+$
Description: Required. Value for parent.
Type: string
Required: Yes
Flat Path: v1alpha1/projects/{projectsId}/locations/{locationsId}/reportConfigs/{reportConfigsId}/reports