2024-04-18
▼ ▲ config.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.
▼ ▲ config.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.
▼ ▲ config.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`.
▼ ▲ config.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.
▼ ▲ config.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`.
▼ ▲ config.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`.
▼ ▲ config.projects.locations.deployments.list
Path: v1/{+parent}/deployments
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments
HTTP Method: GET
Parameters:
parent
Description: Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.
Location: query
Type: string
filter
Description: Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/foo/locations/us-central1/deployments/bar - Filter by labels: - Resources that have a key called 'foo' labels.foo:* - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar - Filter by state: - Deployments in CREATING state. state=CREATING
Location: query
Type: string
orderBy
Description: Field to use to sort the list.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Deployments in a given project and location.
▼ ▲ config.projects.locations.deployments.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details about a Deployment.
▼ ▲ config.projects.locations.deployments.create
Path: v1/{+parent}/deployments
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments
HTTP Method: POST
Parameters:
parent
Description: Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
deploymentId
Description: Required. The Deployment ID.
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 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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Deployment.
▼ ▲ config.projects.locations.deployments.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}
HTTP Method: PATCH
Parameters:
name
Description: Resource name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Optional. Field mask used to specify the fields to be overwritten in the Deployment 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.
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 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
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a Deployment.
▼ ▲ config.projects.locations.deployments.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
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 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
Description: Optional. If set to true, any revisions for this deployment will also be deleted. (Otherwise, the request will only work if the deployment has no revisions.)
Location: query
Type: boolean
deletePolicy
Description: Optional. Policy on how resources actuated by the deployment should be deleted. If unspecified, the default behavior is to delete the underlying resources.
Location: query
Type: string
Enum Descriptions:
Enum:
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Deployment.
▼ ▲ config.projects.locations.deployments.exportState
Path: v1/{+parent}:exportState
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:exportState
HTTP Method: POST
Parameters:
parent
Description: Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Exports Terraform state file from a given deployment.
▼ ▲ config.projects.locations.deployments.importState
Path: v1/{+parent}:importState
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:importState
HTTP Method: POST
Parameters:
parent
Description: Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.
▼ ▲ config.projects.locations.deployments.deleteState
Path: v1/{+name}:deleteState
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:deleteState
HTTP Method: POST
Parameters:
name
Description: Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes Terraform state file in a given deployment.
▼ ▲ config.projects.locations.deployments.lock
Path: v1/{+name}:lock
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:lock
HTTP Method: POST
Parameters:
name
Description: Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Locks a deployment.
▼ ▲ config.projects.locations.deployments.unlock
Path: v1/{+name}:unlock
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:unlock
HTTP Method: POST
Parameters:
name
Description: Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Unlocks a locked deployment.
▼ ▲ config.projects.locations.deployments.exportLock
Path: v1/{+name}:exportLock
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:exportLock
HTTP Method: GET
Parameters:
name
Description: Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Exports the lock info on a locked deployment.
▼ ▲ config.projects.locations.deployments.setIamPolicy
Path: v1/{+resource}:setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:setIamPolicy
HTTP Method: POST
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.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ config.projects.locations.deployments.getIamPolicy
Path: v1/{+resource}:getIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:getIamPolicy
HTTP Method: GET
Parameters:
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.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Type: string
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
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ config.projects.locations.deployments.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:testIamPermissions
HTTP Method: POST
Parameters:
resource
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/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
▼ ▲ config.projects.locations.deployments.revisions.list
Path: v1/{+parent}/revisions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions
HTTP Method: GET
Parameters:
parent
Description: Required. The parent in whose context the Revisions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: When requesting a page of resources, `page_size` specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Token returned by previous call to 'ListRevisions' which specifies the position in the list from where to continue listing the resources.
Location: query
Type: string
filter
Description: Lists the Revisions that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/foo/locations/us-central1/deployments/dep/revisions/bar - Filter by labels: - Resources that have a key called 'foo' labels.foo:* - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar - Filter by state: - Revisions in CREATING state. state=CREATING
Location: query
Type: string
orderBy
Description: Field to use to sort the list.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Revisions of a deployment.
▼ ▲ config.projects.locations.deployments.revisions.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions/{revisionsId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+/revisions/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details about a Revision.
▼ ▲ config.projects.locations.deployments.revisions.exportState
Path: v1/{+parent}:exportState
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions/{revisionsId}:exportState
HTTP Method: POST
Parameters:
parent
Description: Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+/revisions/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Exports Terraform state file from a given revision.
▼ ▲ config.projects.locations.deployments.revisions.resources.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions/{revisionsId}/resources/{resourcesId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the Resource in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+/revisions/[^/]+/resources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details about a Resource deployed by Infra Manager.
▼ ▲ config.projects.locations.deployments.revisions.resources.list
Path: v1/{+parent}/resources
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions/{revisionsId}/resources
HTTP Method: GET
Parameters:
parent
Description: Required. The parent in whose context the Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.
Pattern: ^projects/[^/]+/locations/[^/]+/deployments/[^/]+/revisions/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Token returned by previous call to 'ListResources' which specifies the position in the list from where to continue listing the resources.
Location: query
Type: string
filter
Description: Lists the Resources that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/foo/locations/us-central1/deployments/dep/revisions/bar/resources/baz
Location: query
Type: string
orderBy
Description: Field to use to sort the list.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Resources in a given revision.
▼ ▲ config.projects.locations.previews.create
Path: v1/{+parent}/previews
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/previews
HTTP Method: POST
Parameters:
parent
Description: Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
previewId
Description: Optional. The preview ID.
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 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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a Preview.
▼ ▲ config.projects.locations.previews.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'.
Pattern: ^projects/[^/]+/locations/[^/]+/previews/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details about a Preview.
▼ ▲ config.projects.locations.previews.list
Path: v1/{+parent}/previews
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/previews
HTTP Method: GET
Parameters:
parent
Description: Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.
Location: query
Type: string
filter
Description: Optional. Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/foo/locations/us-central1/deployments/bar - Filter by labels: - Resources that have a key called 'foo' labels.foo:* - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar - Filter by state: - Deployments in CREATING state. state=CREATING
Location: query
Type: string
orderBy
Description: Optional. Field to use to sort the list.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Previews in a given project and location.
▼ ▲ config.projects.locations.previews.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.
Pattern: ^projects/[^/]+/locations/[^/]+/previews/[^/]+$
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 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
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Preview.
▼ ▲ config.projects.locations.previews.export
Path: v1/{+parent}:export
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}:export
HTTP Method: POST
Parameters:
parent
Description: Required. The preview whose results should be exported. The preview value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.
Pattern: ^projects/[^/]+/locations/[^/]+/previews/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Export Preview results.
▼ ▲ config.projects.locations.terraformVersions.list
Path: v1/{+parent}/terraformVersions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/terraformVersions
HTTP Method: GET
Parameters:
parent
Description: Required. The parent in whose context the TerraformVersions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. Token returned by previous call to 'ListTerraformVersions' which specifies the position in the list from where to continue listing the resources.
Location: query
Type: string
filter
Description: Optional. Lists the TerraformVersions that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '<', '>', '<=', '>=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.
Location: query
Type: string
orderBy
Description: Optional. Field to use to sort the list.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists TerraformVersions in a given project and location.
▼ ▲ config.projects.locations.terraformVersions.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/terraformVersions/{terraformVersionsId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the TerraformVersion. Format: 'projects/{project_id}/locations/{location}/terraformVersions/{terraform_version}'
Pattern: ^projects/[^/]+/locations/[^/]+/terraformVersions/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details about a TerraformVersion.