Package google.cloud.parallelstore.v1beta

Index

Parallelstore

Service describing handlers for resources Configures and manages parallelstore resources.

Parallelstore service.

The parallelstore.googleapis.com service implements the parallelstore API and defines the following resource model for managing instances: * The service works with a collection of cloud projects, named: /projects/* * Each project has a collection of available locations, named: /locations/* * Each location has a collection of instances named /instances/*. * Parallelstore instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id}

Note that location_id must be a Google Cloud zone; for example: * projects/12345/locations/us-central1-c/instances/my-parallelstore-share

CreateInstance

rpc CreateInstance(CreateInstanceRequest) returns (Operation)

Creates a Parallelstore instance in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • parallelstore.instances.create

For more information, see the IAM documentation.
DeleteInstance

rpc DeleteInstance(DeleteInstanceRequest) returns (Operation)

Deletes a single instance.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • parallelstore.instances.delete

For more information, see the IAM documentation.
ExportData

rpc ExportData(ExportDataRequest) returns (Operation)

Copies data from Parallelstore to Cloud Storage.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • parallelstore.instances.exportData

For more information, see the IAM documentation.
GetInstance

rpc GetInstance(GetInstanceRequest) returns (Instance)

Gets details of a single instance.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • parallelstore.instances.get

For more information, see the IAM documentation.
ImportData

rpc ImportData(ImportDataRequest) returns (Operation)

Copies data from Cloud Storage to Parallelstore.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • parallelstore.instances.importData

For more information, see the IAM documentation.
ListInstances

rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse)

Lists all instances in a given project and location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • parallelstore.instances.list

For more information, see the IAM documentation.
UpdateInstance

rpc UpdateInstance(UpdateInstanceRequest) returns (Operation)

Updates the parameters of a single instance.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • parallelstore.instances.update

For more information, see the IAM documentation.

CreateInstanceRequest

Create a new Parallelstore instance.

Fields
parent

string

Required. The instance's project and location, in the format projects/{project}/locations/{location}. Locations map to Google Cloud zones; for example, us-west1-b.
instance_id

string

Required. The name of the Parallelstore instance.

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the customer project / location
instance

Instance

Required. The instance to create.
request_id

string

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 t he 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).

DeleteInstanceRequest

Delete an instance.

Fields
name

string

Required. Name of the resource
request_id

string

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 t he 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).

DeploymentType

Represents the deployment type for the instance.

Enums
DEPLOYMENT_TYPE_UNSPECIFIED Default Deployment Type It is equivalent to SCRATCH
SCRATCH Scratch
PERSISTENT Persistent

DestinationGcsBucket

Cloud Storage as the destination of a data transfer.

Fields
uri

string

Required. URI to a Cloud Storage bucket in the format: gs://<bucket_name>/<path_inside_bucket>. The path inside the bucket is optional.

DestinationParallelstore

Parallelstore as the destination of a data transfer.

Fields
path

string

Optional. Root directory path to the Paralellstore filesystem, starting with /. Defaults to / if unset.

DirectoryStripeLevel

Represents the striping options for directories.

Enums
DIRECTORY_STRIPE_LEVEL_UNSPECIFIED If not set, DirectoryStripeLevel will default to DIRECTORY_STRIPE_LEVEL_MAX
DIRECTORY_STRIPE_LEVEL_MIN Minimum directory striping
DIRECTORY_STRIPE_LEVEL_BALANCED Medium directory striping
DIRECTORY_STRIPE_LEVEL_MAX Maximum directory striping

ExportDataMetadata

Metadata related to the data export operation.

Fields
operation_metadata

TransferOperationMetadata

Data transfer operation metadata.
create_time

Timestamp

Output only. The time the operation was created.
end_time

Timestamp

Output only. The time the operation finished running.
target

string

Output only. Server-defined resource path for the target of the operation.
verb

string

Output only. Name of the verb executed by the operation.
status_message

string

Output only. Human-readable status of the operation, if any.
requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version

string

Output only. API version used to start the operation.

ExportDataRequest

Export data from Parallelstore to Cloud Storage.

Fields
name

string

Required. Name of the resource.
request_id

string

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 t he 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).
service_account

string

Optional. User-specified Service Account (SA) credentials to be used when performing the transfer. Use one of the following formats:

  • {EMAIL_ADDRESS_OR_UNIQUE_ID}
  • projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}
  • projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}

If unspecified, the Parallelstore service agent is used: service-<PROJECT_NUMBER>@gcp-sa-parallelstore.iam.gserviceaccount.com
Union field source. The Parallelstore instance to export from. source can be only one of the following:
source_parallelstore

SourceParallelstore

Parallelstore source.
Union field destination. The Cloud Storage bucket to export to. destination can be only one of the following:
destination_gcs_bucket

DestinationGcsBucket

Cloud Storage destination.

ExportDataResponse

This type has no fields.

The response to a request to export data from Parallelstore.

FileStripeLevel

Represents the striping options for files.

Enums
FILE_STRIPE_LEVEL_UNSPECIFIED If not set, FileStripeLevel will default to FILE_STRIPE_LEVEL_BALANCED
FILE_STRIPE_LEVEL_MIN Minimum file striping
FILE_STRIPE_LEVEL_BALANCED Medium file striping
FILE_STRIPE_LEVEL_MAX Maximum file striping

GetInstanceRequest

Get an instance's details.

Fields
name

string

Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}.

ImportDataMetadata

Metadata related to the data import operation.

Fields
operation_metadata

TransferOperationMetadata

Data transfer operation metadata.
create_time

Timestamp

Output only. The time the operation was created.
end_time

Timestamp

Output only. The time the operation finished running.
target

string

Output only. Server-defined resource path for the target of the operation.
verb

string

Output only. Name of the verb executed by the operation.
status_message

string

Output only. Human-readable status of the operation, if any.
requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version

string

Output only. API version used to start the operation.

ImportDataRequest

Import data from Cloud Storage into a Parallelstore instance.

Fields
name

string

Required. Name of the resource.
request_id

string

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 t he 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).
service_account

string

Optional. User-specified service account credentials to be used when performing the transfer.

Use one of the following formats:

  • {EMAIL_ADDRESS_OR_UNIQUE_ID}
  • projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}
  • projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}

If unspecified, the Parallelstore service agent is used: service-<PROJECT_NUMBER>@gcp-sa-parallelstore.iam.gserviceaccount.com
Union field source. The source of the data being imported into the Parallelstore instance. source can be only one of the following:
source_gcs_bucket

SourceGcsBucket

The Cloud Storage source bucket and, optionally, path inside the bucket.
Union field destination. The Parallelstore instance into which to import data. destination can be only one of the following:
destination_parallelstore

DestinationParallelstore

Parallelstore destination.

ImportDataResponse

This type has no fields.

The response to a request to import data to Parallelstore.

Instance

A Parallelstore instance.

Fields
name

string

Identifier. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance_id}.
description

string

Optional. The description of the instance. 2048 characters or less.
state

State

Output only. The instance state.
create_time

Timestamp

Output only. The time when the instance was created.
update_time

Timestamp

Output only. The time when the instance was updated.
labels

map<string, string>

Optional. 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.
capacity_gib

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, ...
daos_version

string

Output only. The version of DAOS software running in the instance.
access_points[]

string

Output only. A list of IPv4 addresses used for client side configuration.
network

string

Optional. Immutable. The name of the Compute Engine VPC network to which the instance is connected.
reserved_ip_range

string

Optional. 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.
effective_reserved_ip_range

string

Output 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.
file_stripe_level

FileStripeLevel

Optional. 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.
directory_stripe_level

DirectoryStripeLevel

Optional. 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.
deployment_type

DeploymentType

Optional. The deployment type of the instance. Allowed values are:

  • SCRATCH: the instance is a scratch instance.
  • PERSISTENT: the instance is a persistent instance.

State

The possible states of a Parallelstore instance.

Enums
STATE_UNSPECIFIED Not set.
CREATING The instance is being created.
ACTIVE The instance is available for use.
DELETING The instance is being deleted.
FAILED The instance is not usable.
UPGRADING The instance is being upgraded.

ListInstancesRequest

List instances request.

Fields
parent

string

Required. The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}.

To retrieve instance information for all locations, use "-" as the value of {location}.
page_size

int32

Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
page_token

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering results.
order_by

string

Optional. Hint for how to order the results.

ListInstancesResponse

Response from ListInstances.

Fields
instances[]

Instance

The list of Parallelstore instances.
next_page_token

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

OperationMetadata

Long-running operation metadata.

Fields
create_time

Timestamp

Output only. The time the operation was created.
end_time

Timestamp

Output only. The time the operation finished running.
target

string

Output only. Server-defined resource path for the target of the operation.
verb

string

Output only. Name of the verb executed by the operation.
status_message

string

Output only. Human-readable status of the operation, if any.
requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version

string

Output only. API version used to start the operation.

SourceGcsBucket

Cloud Storage as the source of a data transfer.

Fields
uri

string

Required. URI to a Cloud Storage bucket in the format: gs://<bucket_name>/<path_inside_bucket>. The path inside the bucket is optional.

SourceParallelstore

Parallelstore as the source of a data transfer.

Fields
path

string

Optional. Root directory path to the Paralellstore filesystem, starting with /. Defaults to / if unset.

TransferCounters

A collection of counters that report the progress of a transfer operation.

Fields
objects_found

int64

Objects found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync.
bytes_found

int64

Bytes found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync.
objects_skipped

int64

Objects in the data source that are not transferred because they already exist in the data destination.
bytes_skipped

int64

Bytes in the data source that are not transferred because they already exist in the data destination.
objects_copied

int64

Objects that are copied to the data destination.
bytes_copied

int64

Bytes that are copied to the data destination.

TransferOperationMetadata

Long-running operation metadata related to a data transfer.

Fields
counters

TransferCounters

Output only. The progress of the transfer operation.
transfer_type

TransferType

Output only. The type of transfer occurring.
Union field source. The source of transfer operation. source can be only one of the following:
source_parallelstore

SourceParallelstore

Output only. Parallelstore source.
source_gcs_bucket

SourceGcsBucket

Output only. Cloud Storage source.
Union field destination. The destination of transfer operation. destination can be only one of the following:
destination_gcs_bucket

DestinationGcsBucket

Output only. Cloud Storage destination.
destination_parallelstore

DestinationParallelstore

Output only. Parallelstore destination.

TransferType

Type of transfer that occurred.

Enums
TRANSFER_TYPE_UNSPECIFIED Zero is an illegal value.
IMPORT Imports to Parallelstore.
EXPORT Exports from Parallelstore.

UpdateInstanceRequest

Update an instance.

Fields
update_mask

FieldMask

Required. Mask of fields to update. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. At least one path must be supplied in this field. The fields specified in the update_mask are relative to the resource, not the full request.
instance

Instance

Required. The instance to update.
request_id

string

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 t he 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).