datastores

Creates, updates, deletes, gets or lists a datastores resource.

Overview

Name	datastores
Type	Resource
Id	google.vmwareengine.datastores

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	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
clusters	array	Output only. Clusters to which the datastore is attached.
createTime	string (google-datetime)	Output only. Creation time of this resource.
description	string	Optional. User-provided description for this datastore
etag	string	Optional. Checksum that may be sent on update and delete requests to ensure that the user-provided value is up to date before the server processes a request. The server computes checksums based on the value of other fields in the request.
nfsDatastore	object	Required. Settings for the NFS datastore. (id: NfsDatastore)
state	string	Output only. The state of the Datastore. (STATE_UNSPECIFIED, CREATING, ACTIVE, UPDATING, DELETING)
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Last update time of this resource.

list

Name	Datatype	Description
name	string	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
clusters	array	Output only. Clusters to which the datastore is attached.
createTime	string (google-datetime)	Output only. Creation time of this resource.
description	string	Optional. User-provided description for this datastore
etag	string	Optional. Checksum that may be sent on update and delete requests to ensure that the user-provided value is up to date before the server processes a request. The server computes checksums based on the value of other fields in the request.
nfsDatastore	object	Required. Settings for the NFS datastore. (id: NfsDatastore)
state	string	Output only. The state of the Datastore. (STATE_UNSPECIFIED, CREATING, ACTIVE, UPDATING, DELETING)
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Last update time of this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, datastoresId		Retrieves a Datastore resource by its resource name. The resource contains details of the Datastore, such as its description, subnets, type, and more.
list	select	projectsId, locationsId	requestId, filter, orderBy, pageToken, pageSize	Lists Datastore resources in a given project and location.
create	insert	projectsId, locationsId	requestId, datastoreId	Creates a new Datastore resource in a given project and location.
patch	update	projectsId, locationsId, datastoresId	updateMask, requestId	Modifies a Datastore resource. Only fields specified in updateMask are applied.
delete	delete	projectsId, locationsId, datastoresId	etag, requestId	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
datastoresId	string
locationsId	string
projectsId	string
datastoreId	string
etag	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Retrieves a Datastore resource by its resource name. The resource contains details of the Datastore, such as its description, subnets, type, and more.

SELECT
name,
clusters,
createTime,
description,
etag,
nfsDatastore,
state,
uid,
updateTime
FROM google.vmwareengine.datastores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datastoresId = '{{ datastoresId }}' -- required
;

list

Lists Datastore resources in a given project and location.

SELECT
name,
clusters,
createTime,
description,
etag,
nfsDatastore,
state,
uid,
updateTime
FROM google.vmwareengine.datastores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND requestId = '{{ requestId }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

create

Creates a new Datastore resource in a given project and location.

INSERT INTO google.vmwareengine.datastores (
data__description,
data__etag,
data__nfsDatastore,
projectsId,
locationsId,
requestId,
datastoreId
)
SELECT 
'{{ description }}',
'{{ etag }}',
'{{ nfsDatastore }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ requestId }}',
'{{ datastoreId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: datastores
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the datastores resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the datastores resource.
  - name: description
    value: "{{ description }}"
    description: |
      Optional. User-provided description for this datastore
  - name: etag
    value: "{{ etag }}"
    description: |
      Optional. Checksum that may be sent on update and delete requests to ensure that the user-provided value is up to date before the server processes a request. The server computes checksums based on the value of other fields in the request.
  - name: nfsDatastore
    description: |
      Required. Settings for the NFS datastore.
    value:
      googleVmwareFileService: "{{ googleVmwareFileService }}"
      googleFileService:
        netappVolume: "{{ netappVolume }}"
        filestoreInstance: "{{ filestoreInstance }}"
      thirdPartyFileService:
        servers:
          - "{{ servers }}"
        fileShare: "{{ fileShare }}"
        network: "{{ network }}"
  - name: requestId
    value: "{{ requestId }}"
  - name: datastoreId
    value: "{{ datastoreId }}"

UPDATE examples

patch

Modifies a Datastore resource. Only fields specified in updateMask are applied.

UPDATE google.vmwareengine.datastores
SET 
data__description = '{{ description }}',
data__etag = '{{ etag }}',
data__nfsDatastore = '{{ nfsDatastore }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND datastoresId = '{{ datastoresId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

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.

DELETE FROM google.vmwareengine.datastores
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND datastoresId = '{{ datastoresId }}' --required
AND etag = '{{ etag }}'
AND requestId = '{{ requestId }}'
;