Skip to main content

instances

Creates, updates, deletes, gets or lists an instances resource.

Overview​

Nameinstances
TypeResource
Idgoogle.parallelstore.instances

Fields​

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringIdentifier. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance_id}.
accessPointsarrayOutput only. A list of IPv4 addresses used for client side configuration.
capacityGibstring (int64)Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ...
createTimestring (google-datetime)Output only. The time when the instance was created.
daosVersionstringOutput only. Deprecated: The version of DAOS software running in the instance.
deploymentTypestringOptional. Immutable. The deployment type of the instance. Allowed values are: * SCRATCH: the instance is a scratch instance. * PERSISTENT: the instance is a persistent instance.
descriptionstringOptional. The description of the instance. 2048 characters or less.
directoryStripeLevelstringOptional. Immutable. Stripe level for directories. Allowed values are: * DIRECTORY_STRIPE_LEVEL_MIN: recommended when directories contain a small number of files. * DIRECTORY_STRIPE_LEVEL_BALANCED: balances performance for workloads involving a mix of small and large directories. * DIRECTORY_STRIPE_LEVEL_MAX: recommended for directories with a large number of files.
effectiveReservedIpRangestringOutput only. Immutable. The ID of the IP address range being used by the instance's VPC network. This field is populated by the service and contains the value currently used by the service.
fileStripeLevelstringOptional. Immutable. Stripe level for files. Allowed values are: * FILE_STRIPE_LEVEL_MIN: offers the best performance for small size files. * FILE_STRIPE_LEVEL_BALANCED: balances performance for workloads involving a mix of small and large files. * FILE_STRIPE_LEVEL_MAX: higher throughput performance for larger files.
labelsobjectOptional. Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. See https://cloud.google.com/resource-manager/docs/labels-overview for details.
networkstringOptional. Immutable. The name of the Compute Engine VPC network to which the instance is connected.
reservedIpRangestringOptional. Immutable. The ID of the IP address range being used by the instance's VPC network. See Configure a VPC network. If no ID is provided, all ranges are considered.
statestringOutput only. The instance state.
updateTimestring (google-datetime)Output only. The time when the instance was updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectsId, locationsId, instancesIdGets details of a single instance.
listselectprojectsId, locationsIdpageSize, pageToken, filter, orderByLists all instances in a given project and location.
createinsertprojectsId, locationsIdinstanceId, requestIdCreates a Parallelstore instance in a given project and location.
patchupdateprojectsId, locationsId, instancesIdupdateMask, requestIdUpdates the parameters of a single instance.
deletedeleteprojectsId, locationsId, instancesIdrequestIdDeletes a single instance.
import_dataexecprojectsId, locationsId, instancesIdCopies data from Cloud Storage to Parallelstore.
export_dataexecprojectsId, locationsId, instancesIdCopies data from Parallelstore to Cloud Storage.

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.

NameDatatypeDescription
instancesIdstring
locationsIdstring
projectsIdstring
filterstring
instanceIdstring
orderBystring
pageSizeinteger (int32)
pageTokenstring
requestIdstring
updateMaskstring (google-fieldmask)

SELECT examples​

Gets details of a single instance.

SELECT
name,
accessPoints,
capacityGib,
createTime,
daosVersion,
deploymentType,
description,
directoryStripeLevel,
effectiveReservedIpRange,
fileStripeLevel,
labels,
network,
reservedIpRange,
state,
updateTime
FROM google.parallelstore.instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required;

INSERT examples​

Creates a Parallelstore instance in a given project and location.

INSERT INTO google.parallelstore.instances (
data__name,
data__description,
data__labels,
data__capacityGib,
data__network,
data__reservedIpRange,
data__fileStripeLevel,
data__directoryStripeLevel,
data__deploymentType,
projectsId,
locationsId,
instanceId,
requestId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ labels }}',
'{{ capacityGib }}',
'{{ network }}',
'{{ reservedIpRange }}',
'{{ fileStripeLevel }}',
'{{ directoryStripeLevel }}',
'{{ deploymentType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ instanceId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

UPDATE examples​

Updates the parameters of a single instance.

UPDATE google.parallelstore.instances
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__labels = '{{ labels }}',
data__capacityGib = '{{ capacityGib }}',
data__network = '{{ network }}',
data__reservedIpRange = '{{ reservedIpRange }}',
data__fileStripeLevel = '{{ fileStripeLevel }}',
data__directoryStripeLevel = '{{ directoryStripeLevel }}',
data__deploymentType = '{{ deploymentType }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples​

Deletes a single instance.

DELETE FROM google.parallelstore.instances
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND requestId = '{{ requestId }}';

Lifecycle Methods​

Copies data from Cloud Storage to Parallelstore.

EXEC google.parallelstore.instances.import_data 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@instancesId='{{ instancesId }}' --required 
@@json=
'{
"sourceGcsBucket": "{{ sourceGcsBucket }}", 
"destinationParallelstore": "{{ destinationParallelstore }}", 
"requestId": "{{ requestId }}", 
"serviceAccount": "{{ serviceAccount }}", 
"metadataOptions": "{{ metadataOptions }}"
}';