package google.cloud.parallelstore.v1beta

Get desktop application:
View/edit binary Protocol Buffers messages

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`

• rpc ListInstances (ListInstancesRequest, ListInstancesResponse)

  parallelstore.proto:71

  Lists all instances in a given project and location.

  message ListInstancesRequest

  parallelstore.proto:395

  List instances request.

  • string parent = 1

    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}`.

  • int32 page_size = 2

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

  • string page_token = 3

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

  • string filter = 4

    Optional. Filtering results.

  • string order_by = 5

    Optional. Hint for how to order the results.

  message ListInstancesResponse

  parallelstore.proto:424

  Response from [ListInstances][google.cloud.parallelstore.v1beta.Parallelstore.ListInstances].

  • repeated Instance instances = 1

    The list of Parallelstore instances.

  • string next_page_token = 2

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

  • repeated string unreachable = 3

    Locations that could not be reached.

• rpc GetInstance (GetInstanceRequest, Instance)

  parallelstore.proto:79

  Gets details of a single instance.

  message GetInstanceRequest

  parallelstore.proto:436

  Get an instance's details.

  • string name = 1

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

• rpc CreateInstance (CreateInstanceRequest, longrunning.Operation)

  parallelstore.proto:87

  Creates a Parallelstore instance in a given project and location.

  message CreateInstanceRequest

  parallelstore.proto:448

  Create a new Parallelstore instance.

  • string parent = 1

    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`.

  • string instance_id = 2

    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

  • optional Instance instance = 3

    Required. The instance to create.

  • string request_id = 4

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

• rpc UpdateInstance (UpdateInstanceRequest, longrunning.Operation)

  parallelstore.proto:101

  Updates the parameters of a single instance.

  message UpdateInstanceRequest

  parallelstore.proto:488

  Update an instance.

  • optional protobuf.FieldMask update_mask = 1

    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.

  • optional Instance instance = 2

    Required. The instance to update.

  • string request_id = 3

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

• rpc DeleteInstance (DeleteInstanceRequest, longrunning.Operation)

  parallelstore.proto:115

  Deletes a single instance.

  message DeleteInstanceRequest

  parallelstore.proto:516

  Delete an instance.

  • string name = 1

    Required. Name of the resource

  • string request_id = 2

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

• rpc ImportData (ImportDataRequest, longrunning.Operation)

  parallelstore.proto:128

  Copies data from Cloud Storage to Parallelstore.

  message ImportDataRequest

  parallelstore.proto:602

  Import data from Cloud Storage into a Parallelstore instance.

  • oneof source

    The source of the data being imported into the Parallelstore instance.

    • SourceGcsBucket source_gcs_bucket = 2

      The Cloud Storage source bucket and, optionally, path inside the bucket.

  • oneof destination

    The Parallelstore instance into which to import data.

    • DestinationParallelstore destination_parallelstore = 3

      Parallelstore destination.

  • string name = 1

    Required. Name of the resource.

  • string request_id = 4

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

  • string service_account = 5

    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`

  • optional TransferMetadataOptions metadata_options = 6

    Optional. The transfer metadata options for the import data.

• rpc ExportData (ExportDataRequest, longrunning.Operation)

  parallelstore.proto:140

  Copies data from Parallelstore to Cloud Storage.

  message ExportDataRequest

  parallelstore.proto:665

  Export data from Parallelstore to Cloud Storage.

  • oneof source

    The Parallelstore instance to export from.

    • SourceParallelstore source_parallelstore = 2

      Parallelstore source.

  • oneof destination

    The Cloud Storage bucket to export to.

    • DestinationGcsBucket destination_gcs_bucket = 3

      Cloud Storage destination.

  • string name = 1

    Required. Name of the resource.

  • string request_id = 4

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

  • string service_account = 5

    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`

  • optional TransferMetadataOptions metadata_options = 6

    Optional. The metadata options for the export data.

Represents the deployment type for the instance.

Used in: Instance

• DEPLOYMENT_TYPE_UNSPECIFIED = 0

  Default Deployment Type It is equivalent to SCRATCH

• SCRATCH = 1

  Scratch

• PERSISTENT = 2

  Persistent

Cloud Storage as the destination of a data transfer.

Used in: ExportDataRequest, TransferOperationMetadata

• string uri = 1

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

Parallelstore as the destination of a data transfer.

Used in: ImportDataRequest, TransferOperationMetadata

• string path = 1

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

Represents the striping options for directories.

Used in: Instance

• DIRECTORY_STRIPE_LEVEL_UNSPECIFIED = 0

  If not set, DirectoryStripeLevel will default to DIRECTORY_STRIPE_LEVEL_MAX

• DIRECTORY_STRIPE_LEVEL_MIN = 1

  Minimum directory striping

• DIRECTORY_STRIPE_LEVEL_BALANCED = 2

  Medium directory striping

• DIRECTORY_STRIPE_LEVEL_MAX = 3

  Maximum directory striping

Metadata related to the data export operation.

• optional TransferOperationMetadata operation_metadata = 1

  Data transfer operation metadata.

• optional protobuf.Timestamp create_time = 2

  Output only. The time the operation was created.

• optional protobuf.Timestamp end_time = 3

  Output only. The time the operation finished running.

• string target = 4

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

• string verb = 5

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

• string status_message = 6

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

• bool requested_cancellation = 7

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

• string api_version = 8

  Output only. API version used to start the operation.

The response to a request to export data from Parallelstore.

(message has no fields)

Represents the striping options for files.

Used in: Instance

• FILE_STRIPE_LEVEL_UNSPECIFIED = 0

  If not set, FileStripeLevel will default to FILE_STRIPE_LEVEL_BALANCED

• FILE_STRIPE_LEVEL_MIN = 1

  Minimum file striping

• FILE_STRIPE_LEVEL_BALANCED = 2

  Medium file striping

• FILE_STRIPE_LEVEL_MAX = 3

  Maximum file striping

Metadata related to the data import operation.

• optional TransferOperationMetadata operation_metadata = 1

  Data transfer operation metadata.

• optional protobuf.Timestamp create_time = 2

  Output only. The time the operation was created.

• optional protobuf.Timestamp end_time = 3

  Output only. The time the operation finished running.

• string target = 4

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

• string verb = 5

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

• string status_message = 6

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

• bool requested_cancellation = 7

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

• string api_version = 8

  Output only. API version used to start the operation.

The response to a request to import data to Parallelstore.

(message has no fields)

A Parallelstore instance.

Used as response type in: Parallelstore.GetInstance

Used as field type in: CreateInstanceRequest, ListInstancesResponse, UpdateInstanceRequest

• string name = 1

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

• string description = 2

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

• Instance.State state = 3

  Output only. The instance state.

• optional protobuf.Timestamp create_time = 4

  Output only. The time when the instance was created.

• optional protobuf.Timestamp update_time = 5

  Output only. The time when the instance was updated.

• map<string, string> labels = 6

  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.

• int64 capacity_gib = 8

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

• string daos_version = 9

  Output only. Deprecated 'daos_version' field. Output only. The version of DAOS software running in the instance.

• repeated string access_points = 10

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

• string network = 11

  Optional. Immutable. The name of the Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.

• string reserved_ip_range = 12

  Optional. Immutable. The ID of the IP address range being used by the instance's VPC network. See [Configure a VPC network](https://cloud.google.com/parallelstore/docs/vpc#create_and_configure_the_vpc). If no ID is provided, all ranges are considered.

• string effective_reserved_ip_range = 14

  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.

• FileStripeLevel file_stripe_level = 15

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

• DirectoryStripeLevel directory_stripe_level = 16

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

• DeploymentType deployment_type = 17

  Optional. Immutable. The deployment type of the instance. Allowed values are: * `SCRATCH`: the instance is a scratch instance. * `PERSISTENT`: the instance is a persistent instance.

The possible states of a Parallelstore instance.

Used in: Instance

• STATE_UNSPECIFIED = 0

  Not set.

• CREATING = 1

  The instance is being created.

• ACTIVE = 2

  The instance is available for use.

• DELETING = 3

  The instance is being deleted.

• FAILED = 4

  The instance is not usable.

• UPGRADING = 5

  The instance is being upgraded.

• REPAIRING = 6

  The instance is being repaired. This should only be used by instances using the `PERSISTENT` deployment type.

Long-running operation metadata.

• optional protobuf.Timestamp create_time = 1

  Output only. The time the operation was created.

• optional protobuf.Timestamp end_time = 2

  Output only. The time the operation finished running.

• string target = 3

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

• string verb = 4

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

• string status_message = 5

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

• bool requested_cancellation = 6

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

• string api_version = 7

  Output only. API version used to start the operation.

Cloud Storage as the source of a data transfer.

Used in: ImportDataRequest, TransferOperationMetadata

• string uri = 1

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

Parallelstore as the source of a data transfer.

Used in: ExportDataRequest, TransferOperationMetadata

• string path = 1

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

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

Used in: TransferOperationMetadata

• int64 objects_found = 1

  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.

• int64 bytes_found = 2

  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.

• int64 objects_skipped = 3

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

• int64 bytes_skipped = 4

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

• int64 objects_copied = 5

  Objects that are copied to the data destination.

• int64 bytes_copied = 6

  Bytes that are copied to the data destination.

• int64 objects_failed = 7

  Objects that are failed to write to the data destination.

• int64 bytes_failed = 8

  Bytes that are failed to write to the data destination.

An entry describing an error that has occurred.

Used in: TransferErrorSummary

• string uri = 1

  A URL that refers to the target (a data source, a data sink, or an object) with which the error is associated.

• repeated string error_details = 2

  A list of messages that carry the error details.

A summary of errors by error code, plus a count and sample error log entries.

Used in: TransferOperationMetadata

• rpc.Code error_code = 1

  One of the error codes that caused the transfer failure.

• int64 error_count = 2

  Count of this type of error.

• repeated TransferErrorLogEntry error_log_entries = 4

  A list of messages that carry the error details.

Transfer metadata options for the instance.

Used in: ExportDataRequest, ImportDataRequest

• TransferMetadataOptions.Uid uid = 1

  Optional. The UID preservation behavior.

• TransferMetadataOptions.Gid gid = 2

  Optional. The GID preservation behavior.

• TransferMetadataOptions.Mode mode = 3

  Optional. The mode preservation behavior.

The GID preservation behavior.

Used in: TransferMetadataOptions

• GID_UNSPECIFIED = 0

  default is GID_NUMBER_PRESERVE.

• GID_SKIP = 1

  Do not preserve GID during a transfer job.

• GID_NUMBER_PRESERVE = 2

  Preserve GID that is in number format during a transfer job.

The mode preservation behavior.

Used in: TransferMetadataOptions

• MODE_UNSPECIFIED = 0

  default is MODE_PRESERVE.

• MODE_SKIP = 1

  Do not preserve mode during a transfer job.

• MODE_PRESERVE = 2

  Preserve mode during a transfer job.

The UID perservation behavior.

Used in: TransferMetadataOptions

• UID_UNSPECIFIED = 0

  default is UID_NUMBER_PRESERVE.

• UID_SKIP = 1

  Do not preserve UID during a transfer job.

• UID_NUMBER_PRESERVE = 2

  Preserve UID that is in number format during a transfer job.

Long-running operation metadata related to a data transfer.

Used in: ExportDataMetadata, ImportDataMetadata

• oneof source

  The source of transfer operation.

  • SourceParallelstore source_parallelstore = 7

    Output only. Parallelstore source.

  • SourceGcsBucket source_gcs_bucket = 8

    Output only. Cloud Storage source.

• oneof destination

  The destination of transfer operation.

  • DestinationGcsBucket destination_gcs_bucket = 9

    Output only. Cloud Storage destination.

  • DestinationParallelstore destination_parallelstore = 10

    Output only. Parallelstore destination.

• optional TransferCounters counters = 3

  Output only. The progress of the transfer operation.

• TransferType transfer_type = 6

  Output only. The type of transfer occurring.

• repeated TransferErrorSummary error_summary = 13

  Output only. List of files that failed to be transferred. This list will have a maximum size of 5 elements.

Type of transfer that occurred.

Used in: TransferOperationMetadata

• TRANSFER_TYPE_UNSPECIFIED = 0

  Zero is an illegal value.

• IMPORT = 1

  Imports to Parallelstore.

• EXPORT = 2

  Exports from Parallelstore.