2025-12-11
▼ ▲ vmwareengine.projects.locations.datastores.delete
Description : Deletes a `Datastore` resource. You can only delete a Datastore after all resources that refer to it are deleted. For example, multiple clusters of the same private cloud or different private clouds can refer to the same datastore.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/datastores/{datastoresId}
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
requestId
Location : query
Description : Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
etag
Location : query
Description : Optional. Checksum used to ensure that the user-provided value is up to date before the server processes the request. The server compares provided checksum with the current checksum of the resource. If the user-provided value is out of date, this request returns an `ABORTED` error.
Type : string
name
Description : Required. The resource name of the Datastore to be deleted. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/datastore/my-datastore`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/datastores/[^/]+$
Type : string
Required : Yes
Path : v1/{+name}
▼ ▲ vmwareengine.projects.locations.datastores.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/datastores
Parameter Order : parent
HTTP Method : POST
Description : Creates a new `Datastore` resource in a given project and location. Datastores are regional resources
Path : v1/{+parent}/datastores
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
requestId
Location : query
Type : string
Description : Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
parent
Required : Yes
Location : path
Description : Required. The resource name of the location to create the new datastore in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1`
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
datastoreId
Location : query
Type : string
Description : Required. The user-provided identifier of the datastore to be created. This identifier must be unique among each `Datastore` within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
▼ ▲ vmwareengine.projects.locations.datastores.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/datastores/{datastoresId}
Parameters :
requestId
Description : Optional. 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
updateMask
Format : google-fieldmask
Location : query
Type : string
Description : Optional. Field mask is used to specify the fields to be overwritten in the Datastore 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. Only the following fields can be updated: `description`.
name
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/datastores/[^/]+$
Description : Output only. Identifier. The resource name of this datastore. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/datastores/datastore`
HTTP Method : PATCH
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Modifies a Datastore resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied.
▼ ▲ vmwareengine.projects.locations.datastores.get
Parameter Order : name
Path : v1/{+name}
Description : Retrieves a `Datastore` resource by its resource name. The resource contains details of the Datastore, such as its description, subnets, type, and more.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/datastores/{datastoresId}
Parameters :
name
Required : Yes
Type : string
Description : Required. The resource name of the Datastore to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/datastores/my-datastore`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/datastores/[^/]+$
▼ ▲ vmwareengine.projects.locations.datastores.list
Parameters :
filter
Location : query
Type : string
Description : Optional. A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of datastores, you can exclude the ones named `example-datastore` by specifying `name != "example-datastore"`. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "example-datastore") (createTime > "2021-04-12T08:15:10.40Z") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "example-datastore-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-datastore-2") ```
requestId
Type : string
Description : Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Location : path
Description : Required. The resource name of the location to query for Datastores. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1`
Type : string
orderBy
Type : string
Description : Optional. Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
Location : query
pageToken
Description : Optional. A page token, received from a previous `ListDatastores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatastores` must match the call that provided the page token.
Type : string
Location : query
pageSize
Format : int32
Description : Optional. The maximum number of results to return in one page. The maximum value is coerced to 1000. The default value of this field is 500.
Type : integer
Location : query
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/datastores
Description : Lists `Datastore` resources in a given project and location.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/datastores
HTTP Method : GET
▼ ▲ vmwareengine.projects.locations.privateClouds.clusters.mountDatastore
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}:mountDatastore
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Required : Yes
Description : Required. The resource name of the cluster to mount the datastore. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$
Type : string
Description : Mounts a `Datastore` on a cluster resource Datastores are zonal resources
HTTP Method : POST
Path : v1/{+name}:mountDatastore
▼ ▲ vmwareengine.projects.locations.privateClouds.clusters.unmountDatastore
Description : Mounts a `Datastore` on a cluster resource Datastores are zonal resources
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}:unmountDatastore
Parameter Order : name
Parameters :
name
Type : string
Description : Required. The resource name of the cluster to unmount the datastore. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$
Location : path
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}:unmountDatastore
HTTP Method : POST