From 027c406aac86c295bfcf131f378416517f576352 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 4 Oct 2024 11:44:17 -0700 Subject: [PATCH] feat(parallelstore-v1beta): Support for the UPGRADING instance state docs(parallelstore-v1beta): Various updates to documentation content and formatting --- .../v1beta/parallelstore/client.rb | 57 +++--- .../v1beta/parallelstore/rest/client.rb | 57 +++--- .../parallelstore/v1beta/parallelstore_pb.rb | 2 +- .../v1beta/parallelstore_services_pb.rb | 12 +- .../parallelstore/v1beta/parallelstore.rb | 188 +++++++++--------- 5 files changed, 168 insertions(+), 148 deletions(-) diff --git a/google-cloud-parallelstore-v1beta/lib/google/cloud/parallelstore/v1beta/parallelstore/client.rb b/google-cloud-parallelstore-v1beta/lib/google/cloud/parallelstore/v1beta/parallelstore/client.rb index 1adf788c671e..4b6132465340 100644 --- a/google-cloud-parallelstore-v1beta/lib/google/cloud/parallelstore/v1beta/parallelstore/client.rb +++ b/google-cloud-parallelstore-v1beta/lib/google/cloud/parallelstore/v1beta/parallelstore/client.rb @@ -207,7 +207,7 @@ def initialize # Service calls ## - # Lists Instances in a given project and location. + # Lists all instances in a given project and location. # # @overload list_instances(request, options = nil) # Pass arguments to `list_instances` via a request object, either of type @@ -227,19 +227,18 @@ def initialize # @param parent [::String] # Required. The project and location for which to retrieve instance # information, in the format `projects/{project_id}/locations/{location}`. - # For Parallelstore locations map to Google Cloud zones, for example - # **us-central1-a**. - # To retrieve instance information for all locations, use "-" for the - # `{location}` value. + # + # To retrieve instance information for all locations, use "-" as the value of + # `{location}`. # @param page_size [::Integer] # Optional. Requested page size. Server may return fewer items than - # requested. If unspecified, server will pick an appropriate default. + # requested. If unspecified, the server will pick an appropriate default. # @param page_token [::String] # Optional. A token identifying a page of results the server should return. # @param filter [::String] - # Optional. Filtering results + # Optional. Filtering results. # @param order_by [::String] - # Optional. Hint for how to order the results + # Optional. Hint for how to order the results. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Parallelstore::V1beta::Instance>] @@ -312,7 +311,7 @@ def list_instances request, options = nil end ## - # Gets details of a single Instance. + # Gets details of a single instance. # # @overload get_instance(request, options = nil) # Pass arguments to `get_instance` via a request object, either of type @@ -419,10 +418,9 @@ def get_instance request, options = nil # @param 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**. + # Locations map to Google Cloud zones; for example, `us-west1-b`. # @param instance_id [::String] - # Required. The logical name of the Parallelstore instance in the user - # project with the following restrictions: + # Required. The name of the Parallelstore instance. # # * Must contain only lowercase letters, numbers, and hyphens. # * Must start with a letter. @@ -520,7 +518,7 @@ def create_instance request, options = nil end ## - # Updates the parameters of a single Instance. + # Updates the parameters of a single instance. # # @overload update_instance(request, options = nil) # Pass arguments to `update_instance` via a request object, either of type @@ -538,12 +536,12 @@ def create_instance request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] - # Required. Mask of fields to update .Field mask is used to specify the + # 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. # @param instance [::Google::Cloud::Parallelstore::V1beta::Instance, ::Hash] - # Required. The instance to update + # Required. The instance to update. # @param 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 @@ -633,7 +631,7 @@ def update_instance request, options = nil end ## - # Deletes a single Instance. + # Deletes a single instance. # # @overload delete_instance(request, options = nil) # Pass arguments to `delete_instance` via a request object, either of type @@ -741,7 +739,7 @@ def delete_instance request, options = nil end ## - # ImportData copies data from Cloud Storage to Parallelstore. + # Copies data from Cloud Storage to Parallelstore. # # @overload import_data(request, options = nil) # Pass arguments to `import_data` via a request object, either of type @@ -759,7 +757,7 @@ def delete_instance request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param source_gcs_bucket [::Google::Cloud::Parallelstore::V1beta::SourceGcsBucket, ::Hash] - # Cloud Storage source. + # The Cloud Storage source bucket and, optionally, path inside the bucket. # @param destination_parallelstore [::Google::Cloud::Parallelstore::V1beta::DestinationParallelstore, ::Hash] # Parallelstore destination. # @param name [::String] @@ -779,11 +777,17 @@ def delete_instance request, options = nil # The request ID must be a valid UUID with the exception that zero UUID is # not supported (00000000-0000-0000-0000-000000000000). # @param service_account [::String] - # Optional. User-specified Service Account (SA) credentials to be used when + # Optional. User-specified service account credentials to be used when # performing the transfer. - # Format: `projects/{project_id}/serviceAccounts/{service_account}` + # + # 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-@gcp-sa-parallelstore.iam.gserviceaccount.com) + # `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] @@ -859,7 +863,7 @@ def import_data request, options = nil end ## - # ExportData copies data from Parallelstore to Cloud Storage + # Copies data from Parallelstore to Cloud Storage. # # @overload export_data(request, options = nil) # Pass arguments to `export_data` via a request object, either of type @@ -899,9 +903,14 @@ def import_data request, options = nil # @param service_account [::String] # Optional. User-specified Service Account (SA) credentials to be used when # performing the transfer. - # Format: `projects/{project_id}/serviceAccounts/{service_account}` + # 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-@gcp-sa-parallelstore.iam.gserviceaccount.com) + # `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] diff --git a/google-cloud-parallelstore-v1beta/lib/google/cloud/parallelstore/v1beta/parallelstore/rest/client.rb b/google-cloud-parallelstore-v1beta/lib/google/cloud/parallelstore/v1beta/parallelstore/rest/client.rb index 3cfdd4490f38..6fcc9157ab6e 100644 --- a/google-cloud-parallelstore-v1beta/lib/google/cloud/parallelstore/v1beta/parallelstore/rest/client.rb +++ b/google-cloud-parallelstore-v1beta/lib/google/cloud/parallelstore/v1beta/parallelstore/rest/client.rb @@ -201,7 +201,7 @@ def initialize # Service calls ## - # Lists Instances in a given project and location. + # Lists all instances in a given project and location. # # @overload list_instances(request, options = nil) # Pass arguments to `list_instances` via a request object, either of type @@ -221,19 +221,18 @@ def initialize # @param parent [::String] # Required. The project and location for which to retrieve instance # information, in the format `projects/{project_id}/locations/{location}`. - # For Parallelstore locations map to Google Cloud zones, for example - # **us-central1-a**. - # To retrieve instance information for all locations, use "-" for the - # `{location}` value. + # + # To retrieve instance information for all locations, use "-" as the value of + # `{location}`. # @param page_size [::Integer] # Optional. Requested page size. Server may return fewer items than - # requested. If unspecified, server will pick an appropriate default. + # requested. If unspecified, the server will pick an appropriate default. # @param page_token [::String] # Optional. A token identifying a page of results the server should return. # @param filter [::String] - # Optional. Filtering results + # Optional. Filtering results. # @param order_by [::String] - # Optional. Hint for how to order the results + # Optional. Hint for how to order the results. # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::Parallelstore::V1beta::ListInstancesResponse] # @yieldparam operation [::Gapic::Rest::TransportOperation] @@ -298,7 +297,7 @@ def list_instances request, options = nil end ## - # Gets details of a single Instance. + # Gets details of a single instance. # # @overload get_instance(request, options = nil) # Pass arguments to `get_instance` via a request object, either of type @@ -398,10 +397,9 @@ def get_instance request, options = nil # @param 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**. + # Locations map to Google Cloud zones; for example, `us-west1-b`. # @param instance_id [::String] - # Required. The logical name of the Parallelstore instance in the user - # project with the following restrictions: + # Required. The name of the Parallelstore instance. # # * Must contain only lowercase letters, numbers, and hyphens. # * Must start with a letter. @@ -492,7 +490,7 @@ def create_instance request, options = nil end ## - # Updates the parameters of a single Instance. + # Updates the parameters of a single instance. # # @overload update_instance(request, options = nil) # Pass arguments to `update_instance` via a request object, either of type @@ -510,12 +508,12 @@ def create_instance request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] - # Required. Mask of fields to update .Field mask is used to specify the + # 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. # @param instance [::Google::Cloud::Parallelstore::V1beta::Instance, ::Hash] - # Required. The instance to update + # Required. The instance to update. # @param 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 @@ -598,7 +596,7 @@ def update_instance request, options = nil end ## - # Deletes a single Instance. + # Deletes a single instance. # # @overload delete_instance(request, options = nil) # Pass arguments to `delete_instance` via a request object, either of type @@ -699,7 +697,7 @@ def delete_instance request, options = nil end ## - # ImportData copies data from Cloud Storage to Parallelstore. + # Copies data from Cloud Storage to Parallelstore. # # @overload import_data(request, options = nil) # Pass arguments to `import_data` via a request object, either of type @@ -717,7 +715,7 @@ def delete_instance request, options = nil # the default parameter values, pass an empty Hash as a request object (see above). # # @param source_gcs_bucket [::Google::Cloud::Parallelstore::V1beta::SourceGcsBucket, ::Hash] - # Cloud Storage source. + # The Cloud Storage source bucket and, optionally, path inside the bucket. # @param destination_parallelstore [::Google::Cloud::Parallelstore::V1beta::DestinationParallelstore, ::Hash] # Parallelstore destination. # @param name [::String] @@ -737,11 +735,17 @@ def delete_instance request, options = nil # The request ID must be a valid UUID with the exception that zero UUID is # not supported (00000000-0000-0000-0000-000000000000). # @param service_account [::String] - # Optional. User-specified Service Account (SA) credentials to be used when + # Optional. User-specified service account credentials to be used when # performing the transfer. - # Format: `projects/{project_id}/serviceAccounts/{service_account}` + # + # 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-@gcp-sa-parallelstore.iam.gserviceaccount.com) + # `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] @@ -810,7 +814,7 @@ def import_data request, options = nil end ## - # ExportData copies data from Parallelstore to Cloud Storage + # Copies data from Parallelstore to Cloud Storage. # # @overload export_data(request, options = nil) # Pass arguments to `export_data` via a request object, either of type @@ -850,9 +854,14 @@ def import_data request, options = nil # @param service_account [::String] # Optional. User-specified Service Account (SA) credentials to be used when # performing the transfer. - # Format: `projects/{project_id}/serviceAccounts/{service_account}` + # 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-@gcp-sa-parallelstore.iam.gserviceaccount.com) + # `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` # @yield [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Gapic::Operation] # @yieldparam operation [::Gapic::Rest::TransportOperation] diff --git a/google-cloud-parallelstore-v1beta/lib/google/cloud/parallelstore/v1beta/parallelstore_pb.rb b/google-cloud-parallelstore-v1beta/lib/google/cloud/parallelstore/v1beta/parallelstore_pb.rb index 3c720e19c9c2..bf00f1472e6e 100644 --- a/google-cloud-parallelstore-v1beta/lib/google/cloud/parallelstore/v1beta/parallelstore_pb.rb +++ b/google-cloud-parallelstore-v1beta/lib/google/cloud/parallelstore/v1beta/parallelstore_pb.rb @@ -15,7 +15,7 @@ require 'google/protobuf/timestamp_pb' -descriptor_data = "\n5google/cloud/parallelstore/v1beta/parallelstore.proto\x12!google.cloud.parallelstore.v1beta\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x1bgoogle/api/field_info.proto\x1a\x19google/api/resource.proto\x1a#google/longrunning/operations.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x93\x08\n\x08Instance\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12\x18\n\x0b\x64\x65scription\x18\x02 \x01(\tB\x03\xe0\x41\x01\x12\x45\n\x05state\x18\x03 \x01(\x0e\x32\x31.google.cloud.parallelstore.v1beta.Instance.StateB\x03\xe0\x41\x03\x12\x34\n\x0b\x63reate_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12L\n\x06labels\x18\x06 \x03(\x0b\x32\x37.google.cloud.parallelstore.v1beta.Instance.LabelsEntryB\x03\xe0\x41\x01\x12\x1c\n\x0c\x63\x61pacity_gib\x18\x08 \x01(\x03\x42\x06\xe0\x41\x05\xe0\x41\x02\x12\x19\n\x0c\x64\x61os_version\x18\t \x01(\tB\x03\xe0\x41\x03\x12\x1a\n\raccess_points\x18\n \x03(\tB\x03\xe0\x41\x03\x12:\n\x07network\x18\x0b \x01(\tB)\xe0\x41\x05\xe0\x41\x01\xfa\x41 \n\x1e\x63ompute.googleapis.com/Network\x12\x44\n\x11reserved_ip_range\x18\x0c \x01(\tB)\xe0\x41\x05\xe0\x41\x01\xfa\x41 \n\x1e\x63ompute.googleapis.com/Address\x12N\n\x1b\x65\x66\x66\x65\x63tive_reserved_ip_range\x18\x0e \x01(\tB)\xe0\x41\x05\xe0\x41\x03\xfa\x41 \n\x1e\x63ompute.googleapis.com/Address\x12R\n\x11\x66ile_stripe_level\x18\x0f \x01(\x0e\x32\x32.google.cloud.parallelstore.v1beta.FileStripeLevelB\x03\xe0\x41\x01\x12\\\n\x16\x64irectory_stripe_level\x18\x10 \x01(\x0e\x32\x37.google.cloud.parallelstore.v1beta.DirectoryStripeLevelB\x03\xe0\x41\x01\x1a-\n\x0bLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"R\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x0c\n\x08\x43REATING\x10\x01\x12\n\n\x06\x41\x43TIVE\x10\x02\x12\x0c\n\x08\x44\x45LETING\x10\x03\x12\n\n\x06\x46\x41ILED\x10\x04:}\xea\x41z\n%parallelstore.googleapis.com/Instance\x12\n\tinstances\x18\x01 \x03(\x0b\x32+.google.cloud.parallelstore.v1beta.Instance\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12\x13\n\x0bunreachable\x18\x03 \x03(\t\"Q\n\x12GetInstanceRequest\x12;\n\x04name\x18\x01 \x01(\tB-\xe0\x41\x02\xfa\x41\'\n%parallelstore.googleapis.com/Instance\"\xcd\x01\n\x15\x43reateInstanceRequest\x12=\n\x06parent\x18\x01 \x01(\tB-\xe0\x41\x02\xfa\x41\'\x12%parallelstore.googleapis.com/Instance\x12\x18\n\x0binstance_id\x18\x02 \x01(\tB\x03\xe0\x41\x02\x12\x42\n\x08instance\x18\x03 \x01(\x0b\x32+.google.cloud.parallelstore.v1beta.InstanceB\x03\xe0\x41\x02\x12\x17\n\nrequest_id\x18\x04 \x01(\tB\x03\xe0\x41\x01\"\xaa\x01\n\x15UpdateInstanceRequest\x12\x34\n\x0bupdate_mask\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.FieldMaskB\x03\xe0\x41\x02\x12\x42\n\x08instance\x18\x02 \x01(\x0b\x32+.google.cloud.parallelstore.v1beta.InstanceB\x03\xe0\x41\x02\x12\x17\n\nrequest_id\x18\x03 \x01(\tB\x03\xe0\x41\x01\"m\n\x15\x44\x65leteInstanceRequest\x12;\n\x04name\x18\x01 \x01(\tB-\xe0\x41\x02\xfa\x41\'\n%parallelstore.googleapis.com/Instance\x12\x17\n\nrequest_id\x18\x02 \x01(\tB\x03\xe0\x41\x01\"\x80\x02\n\x11OperationMetadata\x12\x34\n\x0b\x63reate_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x31\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x13\n\x06target\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12\x11\n\x04verb\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x1b\n\x0estatus_message\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12#\n\x16requested_cancellation\x18\x06 \x01(\x08\x42\x03\xe0\x41\x03\x12\x18\n\x0b\x61pi_version\x18\x07 \x01(\tB\x03\xe0\x41\x03\"#\n\x0fSourceGcsBucket\x12\x10\n\x03uri\x18\x01 \x01(\tB\x03\xe0\x41\x02\"(\n\x14\x44\x65stinationGcsBucket\x12\x10\n\x03uri\x18\x01 \x01(\tB\x03\xe0\x41\x02\"(\n\x13SourceParallelstore\x12\x11\n\x04path\x18\x01 \x01(\tB\x03\xe0\x41\x01\"-\n\x18\x44\x65stinationParallelstore\x12\x11\n\x04path\x18\x01 \x01(\tB\x03\xe0\x41\x01\"\x81\x03\n\x11ImportDataRequest\x12O\n\x11source_gcs_bucket\x18\x02 \x01(\x0b\x32\x32.google.cloud.parallelstore.v1beta.SourceGcsBucketH\x00\x12`\n\x19\x64\x65stination_parallelstore\x18\x03 \x01(\x0b\x32;.google.cloud.parallelstore.v1beta.DestinationParallelstoreH\x01\x12;\n\x04name\x18\x01 \x01(\tB-\xe0\x41\x02\xfa\x41\'\n%parallelstore.googleapis.com/Instance\x12\x1f\n\nrequest_id\x18\x04 \x01(\tB\x0b\xe0\x41\x01\xe2\x8c\xcf\xd7\x08\x02\x08\x01\x12\x42\n\x0fservice_account\x18\x05 \x01(\tB)\xe0\x41\x01\xfa\x41#\n!iam.googleapis.com/ServiceAccountB\x08\n\x06sourceB\r\n\x0b\x64\x65stination\"\x81\x03\n\x11\x45xportDataRequest\x12V\n\x14source_parallelstore\x18\x02 \x01(\x0b\x32\x36.google.cloud.parallelstore.v1beta.SourceParallelstoreH\x00\x12Y\n\x16\x64\x65stination_gcs_bucket\x18\x03 \x01(\x0b\x32\x37.google.cloud.parallelstore.v1beta.DestinationGcsBucketH\x01\x12;\n\x04name\x18\x01 \x01(\tB-\xe0\x41\x02\xfa\x41\'\n%parallelstore.googleapis.com/Instance\x12\x1f\n\nrequest_id\x18\x04 \x01(\tB\x0b\xe0\x41\x01\xe2\x8c\xcf\xd7\x08\x02\x08\x01\x12\x42\n\x0fservice_account\x18\x05 \x01(\tB)\xe0\x41\x01\xfa\x41#\n!iam.googleapis.com/ServiceAccountB\x08\n\x06sourceB\r\n\x0b\x64\x65stination\"\x14\n\x12ImportDataResponse\"\xdb\x02\n\x12ImportDataMetadata\x12X\n\x12operation_metadata\x18\x01 \x01(\x0b\x32<.google.cloud.parallelstore.v1beta.TransferOperationMetadata\x12\x34\n\x0b\x63reate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x31\n\x08\x65nd_time\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x13\n\x06target\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x11\n\x04verb\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x1b\n\x0estatus_message\x18\x06 \x01(\tB\x03\xe0\x41\x03\x12#\n\x16requested_cancellation\x18\x07 \x01(\x08\x42\x03\xe0\x41\x03\x12\x18\n\x0b\x61pi_version\x18\x08 \x01(\tB\x03\xe0\x41\x03\"\x14\n\x12\x45xportDataResponse\"\xdb\x02\n\x12\x45xportDataMetadata\x12X\n\x12operation_metadata\x18\x01 \x01(\x0b\x32<.google.cloud.parallelstore.v1beta.TransferOperationMetadata\x12\x34\n\x0b\x63reate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x31\n\x08\x65nd_time\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x13\n\x06target\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x11\n\x04verb\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x1b\n\x0estatus_message\x18\x06 \x01(\tB\x03\xe0\x41\x03\x12#\n\x16requested_cancellation\x18\x07 \x01(\x08\x42\x03\xe0\x41\x03\x12\x18\n\x0b\x61pi_version\x18\x08 \x01(\tB\x03\xe0\x41\x03\"\xc7\x04\n\x19TransferOperationMetadata\x12[\n\x14source_parallelstore\x18\x07 \x01(\x0b\x32\x36.google.cloud.parallelstore.v1beta.SourceParallelstoreB\x03\xe0\x41\x03H\x00\x12T\n\x11source_gcs_bucket\x18\x08 \x01(\x0b\x32\x32.google.cloud.parallelstore.v1beta.SourceGcsBucketB\x03\xe0\x41\x03H\x00\x12^\n\x16\x64\x65stination_gcs_bucket\x18\t \x01(\x0b\x32\x37.google.cloud.parallelstore.v1beta.DestinationGcsBucketB\x03\xe0\x41\x03H\x01\x12\x65\n\x19\x64\x65stination_parallelstore\x18\n \x01(\x0b\x32;.google.cloud.parallelstore.v1beta.DestinationParallelstoreB\x03\xe0\x41\x03H\x01\x12J\n\x08\x63ounters\x18\x03 \x01(\x0b\x32\x33.google.cloud.parallelstore.v1beta.TransferCountersB\x03\xe0\x41\x03\x12K\n\rtransfer_type\x18\x06 \x01(\x0e\x32/.google.cloud.parallelstore.v1beta.TransferTypeB\x03\xe0\x41\x03\x42\x08\n\x06sourceB\r\n\x0b\x64\x65stination\"\x9c\x01\n\x10TransferCounters\x12\x15\n\robjects_found\x18\x01 \x01(\x03\x12\x13\n\x0b\x62ytes_found\x18\x02 \x01(\x03\x12\x17\n\x0fobjects_skipped\x18\x03 \x01(\x03\x12\x15\n\rbytes_skipped\x18\x04 \x01(\x03\x12\x16\n\x0eobjects_copied\x18\x05 \x01(\x03\x12\x14\n\x0c\x62ytes_copied\x18\x06 \x01(\x03*E\n\x0cTransferType\x12\x1d\n\x19TRANSFER_TYPE_UNSPECIFIED\x10\x00\x12\n\n\x06IMPORT\x10\x01\x12\n\n\x06\x45XPORT\x10\x02*\x8a\x01\n\x0f\x46ileStripeLevel\x12!\n\x1d\x46ILE_STRIPE_LEVEL_UNSPECIFIED\x10\x00\x12\x19\n\x15\x46ILE_STRIPE_LEVEL_MIN\x10\x01\x12\x1e\n\x1a\x46ILE_STRIPE_LEVEL_BALANCED\x10\x02\x12\x19\n\x15\x46ILE_STRIPE_LEVEL_MAX\x10\x03*\xa3\x01\n\x14\x44irectoryStripeLevel\x12&\n\"DIRECTORY_STRIPE_LEVEL_UNSPECIFIED\x10\x00\x12\x1e\n\x1a\x44IRECTORY_STRIPE_LEVEL_MIN\x10\x01\x12#\n\x1f\x44IRECTORY_STRIPE_LEVEL_BALANCED\x10\x02\x12\x1e\n\x1a\x44IRECTORY_STRIPE_LEVEL_MAX\x10\x03\x32\xcd\x0c\n\rParallelstore\x12\xc6\x01\n\rListInstances\x12\x37.google.cloud.parallelstore.v1beta.ListInstancesRequest\x1a\x38.google.cloud.parallelstore.v1beta.ListInstancesResponse\"B\xda\x41\x06parent\x82\xd3\xe4\x93\x02\x33\x12\x31/v1beta/{parent=projects/*/locations/*}/instances\x12\xb3\x01\n\x0bGetInstance\x12\x35.google.cloud.parallelstore.v1beta.GetInstanceRequest\x1a+.google.cloud.parallelstore.v1beta.Instance\"@\xda\x41\x04name\x82\xd3\xe4\x93\x02\x33\x12\x31/v1beta/{name=projects/*/locations/*/instances/*}\x12\xed\x01\n\x0e\x43reateInstance\x12\x38.google.cloud.parallelstore.v1beta.CreateInstanceRequest\x1a\x1d.google.longrunning.Operation\"\x81\x01\xca\x41\x1d\n\x08Instance\x12\x11OperationMetadata\xda\x41\x1bparent,instance,instance_id\x82\xd3\xe4\x93\x02=\"1/v1beta/{parent=projects/*/locations/*}/instances:\x08instance\x12\xef\x01\n\x0eUpdateInstance\x12\x38.google.cloud.parallelstore.v1beta.UpdateInstanceRequest\x1a\x1d.google.longrunning.Operation\"\x83\x01\xca\x41\x1d\n\x08Instance\x12\x11OperationMetadata\xda\x41\x14instance,update_mask\x82\xd3\xe4\x93\x02\x46\x32:/v1beta/{instance.name=projects/*/locations/*/instances/*}:\x08instance\x12\xd8\x01\n\x0e\x44\x65leteInstance\x12\x38.google.cloud.parallelstore.v1beta.DeleteInstanceRequest\x1a\x1d.google.longrunning.Operation\"m\xca\x41*\n\x15google.protobuf.Empty\x12\x11OperationMetadata\xda\x41\x04name\x82\xd3\xe4\x93\x02\x33*1/v1beta/{name=projects/*/locations/*/instances/*}\x12\xd5\x01\n\nImportData\x12\x34.google.cloud.parallelstore.v1beta.ImportDataRequest\x1a\x1d.google.longrunning.Operation\"r\xca\x41(\n\x12ImportDataResponse\x12\x12ImportDataMetadata\x82\xd3\xe4\x93\x02\x41\"\n\tinstances\x18\x01 \x03(\x0b\x32+.google.cloud.parallelstore.v1beta.Instance\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\x12\x13\n\x0bunreachable\x18\x03 \x03(\t\"Q\n\x12GetInstanceRequest\x12;\n\x04name\x18\x01 \x01(\tB-\xe0\x41\x02\xfa\x41\'\n%parallelstore.googleapis.com/Instance\"\xcd\x01\n\x15\x43reateInstanceRequest\x12=\n\x06parent\x18\x01 \x01(\tB-\xe0\x41\x02\xfa\x41\'\x12%parallelstore.googleapis.com/Instance\x12\x18\n\x0binstance_id\x18\x02 \x01(\tB\x03\xe0\x41\x02\x12\x42\n\x08instance\x18\x03 \x01(\x0b\x32+.google.cloud.parallelstore.v1beta.InstanceB\x03\xe0\x41\x02\x12\x17\n\nrequest_id\x18\x04 \x01(\tB\x03\xe0\x41\x01\"\xaa\x01\n\x15UpdateInstanceRequest\x12\x34\n\x0bupdate_mask\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.FieldMaskB\x03\xe0\x41\x02\x12\x42\n\x08instance\x18\x02 \x01(\x0b\x32+.google.cloud.parallelstore.v1beta.InstanceB\x03\xe0\x41\x02\x12\x17\n\nrequest_id\x18\x03 \x01(\tB\x03\xe0\x41\x01\"m\n\x15\x44\x65leteInstanceRequest\x12;\n\x04name\x18\x01 \x01(\tB-\xe0\x41\x02\xfa\x41\'\n%parallelstore.googleapis.com/Instance\x12\x17\n\nrequest_id\x18\x02 \x01(\tB\x03\xe0\x41\x01\"\x80\x02\n\x11OperationMetadata\x12\x34\n\x0b\x63reate_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x31\n\x08\x65nd_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x13\n\x06target\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12\x11\n\x04verb\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x1b\n\x0estatus_message\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12#\n\x16requested_cancellation\x18\x06 \x01(\x08\x42\x03\xe0\x41\x03\x12\x18\n\x0b\x61pi_version\x18\x07 \x01(\tB\x03\xe0\x41\x03\"#\n\x0fSourceGcsBucket\x12\x10\n\x03uri\x18\x01 \x01(\tB\x03\xe0\x41\x02\"(\n\x14\x44\x65stinationGcsBucket\x12\x10\n\x03uri\x18\x01 \x01(\tB\x03\xe0\x41\x02\"(\n\x13SourceParallelstore\x12\x11\n\x04path\x18\x01 \x01(\tB\x03\xe0\x41\x01\"-\n\x18\x44\x65stinationParallelstore\x12\x11\n\x04path\x18\x01 \x01(\tB\x03\xe0\x41\x01\"\x81\x03\n\x11ImportDataRequest\x12O\n\x11source_gcs_bucket\x18\x02 \x01(\x0b\x32\x32.google.cloud.parallelstore.v1beta.SourceGcsBucketH\x00\x12`\n\x19\x64\x65stination_parallelstore\x18\x03 \x01(\x0b\x32;.google.cloud.parallelstore.v1beta.DestinationParallelstoreH\x01\x12;\n\x04name\x18\x01 \x01(\tB-\xe0\x41\x02\xfa\x41\'\n%parallelstore.googleapis.com/Instance\x12\x1f\n\nrequest_id\x18\x04 \x01(\tB\x0b\xe0\x41\x01\xe2\x8c\xcf\xd7\x08\x02\x08\x01\x12\x42\n\x0fservice_account\x18\x05 \x01(\tB)\xe0\x41\x01\xfa\x41#\n!iam.googleapis.com/ServiceAccountB\x08\n\x06sourceB\r\n\x0b\x64\x65stination\"\x81\x03\n\x11\x45xportDataRequest\x12V\n\x14source_parallelstore\x18\x02 \x01(\x0b\x32\x36.google.cloud.parallelstore.v1beta.SourceParallelstoreH\x00\x12Y\n\x16\x64\x65stination_gcs_bucket\x18\x03 \x01(\x0b\x32\x37.google.cloud.parallelstore.v1beta.DestinationGcsBucketH\x01\x12;\n\x04name\x18\x01 \x01(\tB-\xe0\x41\x02\xfa\x41\'\n%parallelstore.googleapis.com/Instance\x12\x1f\n\nrequest_id\x18\x04 \x01(\tB\x0b\xe0\x41\x01\xe2\x8c\xcf\xd7\x08\x02\x08\x01\x12\x42\n\x0fservice_account\x18\x05 \x01(\tB)\xe0\x41\x01\xfa\x41#\n!iam.googleapis.com/ServiceAccountB\x08\n\x06sourceB\r\n\x0b\x64\x65stination\"\x14\n\x12ImportDataResponse\"\xdb\x02\n\x12ImportDataMetadata\x12X\n\x12operation_metadata\x18\x01 \x01(\x0b\x32<.google.cloud.parallelstore.v1beta.TransferOperationMetadata\x12\x34\n\x0b\x63reate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x31\n\x08\x65nd_time\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x13\n\x06target\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x11\n\x04verb\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x1b\n\x0estatus_message\x18\x06 \x01(\tB\x03\xe0\x41\x03\x12#\n\x16requested_cancellation\x18\x07 \x01(\x08\x42\x03\xe0\x41\x03\x12\x18\n\x0b\x61pi_version\x18\x08 \x01(\tB\x03\xe0\x41\x03\"\x14\n\x12\x45xportDataResponse\"\xdb\x02\n\x12\x45xportDataMetadata\x12X\n\x12operation_metadata\x18\x01 \x01(\x0b\x32<.google.cloud.parallelstore.v1beta.TransferOperationMetadata\x12\x34\n\x0b\x63reate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x31\n\x08\x65nd_time\x18\x03 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x13\n\x06target\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x11\n\x04verb\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x1b\n\x0estatus_message\x18\x06 \x01(\tB\x03\xe0\x41\x03\x12#\n\x16requested_cancellation\x18\x07 \x01(\x08\x42\x03\xe0\x41\x03\x12\x18\n\x0b\x61pi_version\x18\x08 \x01(\tB\x03\xe0\x41\x03\"\xc7\x04\n\x19TransferOperationMetadata\x12[\n\x14source_parallelstore\x18\x07 \x01(\x0b\x32\x36.google.cloud.parallelstore.v1beta.SourceParallelstoreB\x03\xe0\x41\x03H\x00\x12T\n\x11source_gcs_bucket\x18\x08 \x01(\x0b\x32\x32.google.cloud.parallelstore.v1beta.SourceGcsBucketB\x03\xe0\x41\x03H\x00\x12^\n\x16\x64\x65stination_gcs_bucket\x18\t \x01(\x0b\x32\x37.google.cloud.parallelstore.v1beta.DestinationGcsBucketB\x03\xe0\x41\x03H\x01\x12\x65\n\x19\x64\x65stination_parallelstore\x18\n \x01(\x0b\x32;.google.cloud.parallelstore.v1beta.DestinationParallelstoreB\x03\xe0\x41\x03H\x01\x12J\n\x08\x63ounters\x18\x03 \x01(\x0b\x32\x33.google.cloud.parallelstore.v1beta.TransferCountersB\x03\xe0\x41\x03\x12K\n\rtransfer_type\x18\x06 \x01(\x0e\x32/.google.cloud.parallelstore.v1beta.TransferTypeB\x03\xe0\x41\x03\x42\x08\n\x06sourceB\r\n\x0b\x64\x65stination\"\x9c\x01\n\x10TransferCounters\x12\x15\n\robjects_found\x18\x01 \x01(\x03\x12\x13\n\x0b\x62ytes_found\x18\x02 \x01(\x03\x12\x17\n\x0fobjects_skipped\x18\x03 \x01(\x03\x12\x15\n\rbytes_skipped\x18\x04 \x01(\x03\x12\x16\n\x0eobjects_copied\x18\x05 \x01(\x03\x12\x14\n\x0c\x62ytes_copied\x18\x06 \x01(\x03*E\n\x0cTransferType\x12\x1d\n\x19TRANSFER_TYPE_UNSPECIFIED\x10\x00\x12\n\n\x06IMPORT\x10\x01\x12\n\n\x06\x45XPORT\x10\x02*\x8a\x01\n\x0f\x46ileStripeLevel\x12!\n\x1d\x46ILE_STRIPE_LEVEL_UNSPECIFIED\x10\x00\x12\x19\n\x15\x46ILE_STRIPE_LEVEL_MIN\x10\x01\x12\x1e\n\x1a\x46ILE_STRIPE_LEVEL_BALANCED\x10\x02\x12\x19\n\x15\x46ILE_STRIPE_LEVEL_MAX\x10\x03*\xa3\x01\n\x14\x44irectoryStripeLevel\x12&\n\"DIRECTORY_STRIPE_LEVEL_UNSPECIFIED\x10\x00\x12\x1e\n\x1a\x44IRECTORY_STRIPE_LEVEL_MIN\x10\x01\x12#\n\x1f\x44IRECTORY_STRIPE_LEVEL_BALANCED\x10\x02\x12\x1e\n\x1a\x44IRECTORY_STRIPE_LEVEL_MAX\x10\x03\x32\xcd\x0c\n\rParallelstore\x12\xc6\x01\n\rListInstances\x12\x37.google.cloud.parallelstore.v1beta.ListInstancesRequest\x1a\x38.google.cloud.parallelstore.v1beta.ListInstancesResponse\"B\xda\x41\x06parent\x82\xd3\xe4\x93\x02\x33\x12\x31/v1beta/{parent=projects/*/locations/*}/instances\x12\xb3\x01\n\x0bGetInstance\x12\x35.google.cloud.parallelstore.v1beta.GetInstanceRequest\x1a+.google.cloud.parallelstore.v1beta.Instance\"@\xda\x41\x04name\x82\xd3\xe4\x93\x02\x33\x12\x31/v1beta/{name=projects/*/locations/*/instances/*}\x12\xed\x01\n\x0e\x43reateInstance\x12\x38.google.cloud.parallelstore.v1beta.CreateInstanceRequest\x1a\x1d.google.longrunning.Operation\"\x81\x01\xca\x41\x1d\n\x08Instance\x12\x11OperationMetadata\xda\x41\x1bparent,instance,instance_id\x82\xd3\xe4\x93\x02=\"1/v1beta/{parent=projects/*/locations/*}/instances:\x08instance\x12\xef\x01\n\x0eUpdateInstance\x12\x38.google.cloud.parallelstore.v1beta.UpdateInstanceRequest\x1a\x1d.google.longrunning.Operation\"\x83\x01\xca\x41\x1d\n\x08Instance\x12\x11OperationMetadata\xda\x41\x14instance,update_mask\x82\xd3\xe4\x93\x02\x46\x32:/v1beta/{instance.name=projects/*/locations/*/instances/*}:\x08instance\x12\xd8\x01\n\x0e\x44\x65leteInstance\x12\x38.google.cloud.parallelstore.v1beta.DeleteInstanceRequest\x1a\x1d.google.longrunning.Operation\"m\xca\x41*\n\x15google.protobuf.Empty\x12\x11OperationMetadata\xda\x41\x04name\x82\xd3\xe4\x93\x02\x33*1/v1beta/{name=projects/*/locations/*/instances/*}\x12\xd5\x01\n\nImportData\x12\x34.google.cloud.parallelstore.v1beta.ImportDataRequest\x1a\x1d.google.longrunning.Operation\"r\xca\x41(\n\x12ImportDataResponse\x12\x12ImportDataMetadata\x82\xd3\xe4\x93\x02\x41\" ::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. Cloud Labels can be used to - # filter collections of resources. They can be used to control how resource - # metrics are aggregated. And they can be used as arguments to policy - # management rules (e.g. route, firewall, load balancing, etc.). - # - # * Label keys must be between 1 and 63 characters long and must conform to - # the following regular expression: `[a-z][a-z0-9_-]{0,62}`. - # * Label values must be between 0 and 63 characters long and must conform - # to the regular expression `[a-z0-9_-]{0,63}`. - # * No more than 64 labels can be associated with a given resource. - # - # See https://goo.gl/xmQnxf for more information on and examples of labels. - # - # If you plan to use labels in your own code, please note that additional - # characters may be allowed in the future. Therefore, you are advised to use - # an internal label representation, such as JSON, which doesn't rely upon - # specific characters being disallowed. For example, representing labels - # as the string: name + "_" + value would prove problematic if we were to - # allow "_" in a future release. + # organizational needs and deployment strategies. See + # https://cloud.google.com/resource-manager/docs/labels-overview for details. # @!attribute [rw] capacity_gib # @return [::Integer] - # Required. Immutable. Storage capacity of Parallelstore instance in - # Gibibytes (GiB). + # 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, ... # @!attribute [r] daos_version # @return [::String] - # Output only. The version of DAOS software running in the instance + # Output only. The version of DAOS software running in the instance. # @!attribute [r] access_points # @return [::Array<::String>] - # Output only. List of access_points. - # Contains a list of IPv4 addresses used for client side configuration. + # Output only. A list of IPv4 addresses used for client side configuration. # @!attribute [rw] network # @return [::String] - # Optional. Immutable. The name of the Google Compute Engine + # Optional. Immutable. The name of the Compute Engine # [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the # instance is connected. # @!attribute [rw] reserved_ip_range # @return [::String] - # Optional. Immutable. Contains the id of the allocated IP address range - # associated with the private service access connection for example, - # "test-default" associated with IP range 10.0.0.0/29. If no range id is - # provided all ranges will be considered. + # 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. # @!attribute [r] effective_reserved_ip_range # @return [::String] - # Output only. Immutable. Contains the id of the allocated IP address range - # associated with the private service access connection for example, - # "test-default" associated with IP range 10.0.0.0/29. This field is - # populated by the service and and contains the value currently used by the - # service. + # 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. # @!attribute [rw] file_stripe_level # @return [::Google::Cloud::Parallelstore::V1beta::FileStripeLevel] - # Optional. Stripe level for files. - # MIN better suited for small size files. - # MAX higher throughput performance for larger files. + # 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. # @!attribute [rw] directory_stripe_level # @return [::Google::Cloud::Parallelstore::V1beta::DirectoryStripeLevel] - # Optional. Stripe level for directories. - # MIN when directory has a small number of files. - # MAX when directory has a large number of files. + # 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. class Instance include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods @@ -113,7 +103,7 @@ class LabelsEntry extend ::Google::Protobuf::MessageExts::ClassMethods end - # Represents the different states of a Parallelstore instance. + # The possible states of a Parallelstore instance. module State # Not set. STATE_UNSPECIFIED = 0 @@ -129,40 +119,43 @@ module State # The instance is not usable. FAILED = 4 + + # The instance is being upgraded. + UPGRADING = 5 end end - # Message for requesting list of Instances + # List instances request. # @!attribute [rw] parent # @return [::String] # Required. The project and location for which to retrieve instance # information, in the format `projects/{project_id}/locations/{location}`. - # For Parallelstore locations map to Google Cloud zones, for example - # **us-central1-a**. - # To retrieve instance information for all locations, use "-" for the - # `{location}` value. + # + # To retrieve instance information for all locations, use "-" as the value of + # `{location}`. # @!attribute [rw] page_size # @return [::Integer] # Optional. Requested page size. Server may return fewer items than - # requested. If unspecified, server will pick an appropriate default. + # requested. If unspecified, the server will pick an appropriate default. # @!attribute [rw] page_token # @return [::String] # Optional. A token identifying a page of results the server should return. # @!attribute [rw] filter # @return [::String] - # Optional. Filtering results + # Optional. Filtering results. # @!attribute [rw] order_by # @return [::String] - # Optional. Hint for how to order the results + # Optional. Hint for how to order the results. class ListInstancesRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Message for response to listing Instances + # Response from + # {::Google::Cloud::Parallelstore::V1beta::Parallelstore::Client#list_instances ListInstances}. # @!attribute [rw] instances # @return [::Array<::Google::Cloud::Parallelstore::V1beta::Instance>] - # The list of Parallelstore Instances + # The list of Parallelstore instances. # @!attribute [rw] next_page_token # @return [::String] # A token identifying a page of results the server should return. @@ -174,7 +167,7 @@ class ListInstancesResponse extend ::Google::Protobuf::MessageExts::ClassMethods end - # Request to get an instance's details. + # Get an instance's details. # @!attribute [rw] name # @return [::String] # Required. The instance resource name, in the format @@ -184,17 +177,15 @@ class GetInstanceRequest extend ::Google::Protobuf::MessageExts::ClassMethods end - # Request for - # {::Google::Cloud::Parallelstore::V1beta::Parallelstore::Client#create_instance CreateInstance} + # Create a new Parallelstore instance. # @!attribute [rw] parent # @return [::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**. + # Locations map to Google Cloud zones; for example, `us-west1-b`. # @!attribute [rw] instance_id # @return [::String] - # Required. The logical name of the Parallelstore instance in the user - # project with the following restrictions: + # Required. The name of the Parallelstore instance. # # * Must contain only lowercase letters, numbers, and hyphens. # * Must start with a letter. @@ -224,16 +215,16 @@ class CreateInstanceRequest extend ::Google::Protobuf::MessageExts::ClassMethods end - # Message for updating a Instance + # Update an instance. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] - # Required. Mask of fields to update .Field mask is used to specify the + # 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. # @!attribute [rw] instance # @return [::Google::Cloud::Parallelstore::V1beta::Instance] - # Required. The instance to update + # Required. The instance to update. # @!attribute [rw] request_id # @return [::String] # Optional. An optional request ID to identify requests. Specify a unique @@ -254,7 +245,7 @@ class UpdateInstanceRequest extend ::Google::Protobuf::MessageExts::ClassMethods end - # Message for deleting a Instance + # Delete an instance. # @!attribute [rw] name # @return [::String] # Required. Name of the resource @@ -278,7 +269,7 @@ class DeleteInstanceRequest extend ::Google::Protobuf::MessageExts::ClassMethods end - # Represents the metadata of the long-running operation. + # Long-running operation metadata. # @!attribute [r] create_time # @return [::Google::Protobuf::Timestamp] # Output only. The time the operation was created. @@ -309,51 +300,52 @@ class OperationMetadata extend ::Google::Protobuf::MessageExts::ClassMethods end - # Google Cloud Storage as a source. + # Cloud Storage as the source of a data transfer. # @!attribute [rw] uri # @return [::String] - # Required. URI to a Cloud Storage object in format: - # 'gs:///'. + # Required. URI to a Cloud Storage bucket in the format: + # `gs:///`. The path inside the bucket is + # optional. class SourceGcsBucket include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Google Cloud Storage as a destination. + # Cloud Storage as the destination of a data transfer. # @!attribute [rw] uri # @return [::String] - # Required. URI to a Cloud Storage object in format: - # 'gs:///'. + # Required. URI to a Cloud Storage bucket in the format: + # `gs:///`. The path inside the bucket is + # optional. class DestinationGcsBucket include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Pa as a source. + # Parallelstore as the source of a data transfer. # @!attribute [rw] path # @return [::String] # Optional. Root directory path to the Paralellstore filesystem, starting - # with '/'. Defaults to '/' if unset. + # with `/`. Defaults to `/` if unset. class SourceParallelstore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Parallelstore as a destination. + # Parallelstore as the destination of a data transfer. # @!attribute [rw] path # @return [::String] # Optional. Root directory path to the Paralellstore filesystem, starting - # with '/'. Defaults to '/' if unset. + # with `/`. Defaults to `/` if unset. class DestinationParallelstore include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Message representing the request importing data from parallelstore to Cloud - # Storage. + # Import data from Cloud Storage into a Parallelstore instance. # @!attribute [rw] source_gcs_bucket # @return [::Google::Cloud::Parallelstore::V1beta::SourceGcsBucket] - # Cloud Storage source. + # The Cloud Storage source bucket and, optionally, path inside the bucket. # @!attribute [rw] destination_parallelstore # @return [::Google::Cloud::Parallelstore::V1beta::DestinationParallelstore] # Parallelstore destination. @@ -377,18 +369,23 @@ class DestinationParallelstore # not supported (00000000-0000-0000-0000-000000000000). # @!attribute [rw] service_account # @return [::String] - # Optional. User-specified Service Account (SA) credentials to be used when + # Optional. User-specified service account credentials to be used when # performing the transfer. - # Format: `projects/{project_id}/serviceAccounts/{service_account}` + # + # 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-@gcp-sa-parallelstore.iam.gserviceaccount.com) + # `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` class ImportDataRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # Message representing the request exporting data from Cloud Storage to - # parallelstore. + # Export data from Parallelstore to Cloud Storage. # @!attribute [rw] source_parallelstore # @return [::Google::Cloud::Parallelstore::V1beta::SourceParallelstore] # Parallelstore source. @@ -417,24 +414,29 @@ class ImportDataRequest # @return [::String] # Optional. User-specified Service Account (SA) credentials to be used when # performing the transfer. - # Format: `projects/{project_id}/serviceAccounts/{service_account}` + # 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-@gcp-sa-parallelstore.iam.gserviceaccount.com) + # `service-@gcp-sa-parallelstore.iam.gserviceaccount.com` class ExportDataRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # ImportDataResponse is the response returned from ImportData rpc. + # The response to a request to import data to Parallelstore. class ImportDataResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # ImportDataMetadata contains import data operation metadata + # Metadata related to the data import operation. # @!attribute [rw] operation_metadata # @return [::Google::Cloud::Parallelstore::V1beta::TransferOperationMetadata] - # Contains the data transfer operation metadata. + # Data transfer operation metadata. # @!attribute [r] create_time # @return [::Google::Protobuf::Timestamp] # Output only. The time the operation was created. @@ -465,16 +467,16 @@ class ImportDataMetadata extend ::Google::Protobuf::MessageExts::ClassMethods end - # ExportDataResponse is the response returned from ExportData rpc + # The response to a request to export data from Parallelstore. class ExportDataResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end - # ExportDataMetadata contains export data operation metadata + # Metadata related to the data export operation. # @!attribute [rw] operation_metadata # @return [::Google::Cloud::Parallelstore::V1beta::TransferOperationMetadata] - # Contains the data transfer operation metadata. + # Data transfer operation metadata. # @!attribute [r] create_time # @return [::Google::Protobuf::Timestamp] # Output only. The time the operation was created. @@ -505,7 +507,7 @@ class ExportDataMetadata extend ::Google::Protobuf::MessageExts::ClassMethods end - # Represents the metadata of the long-running operation. + # Long-running operation metadata related to a data transfer. # @!attribute [r] source_parallelstore # @return [::Google::Cloud::Parallelstore::V1beta::SourceParallelstore] # Output only. Parallelstore source. @@ -520,7 +522,7 @@ class ExportDataMetadata # Output only. Parallelstore destination. # @!attribute [r] counters # @return [::Google::Cloud::Parallelstore::V1beta::TransferCounters] - # Output only. Information about the progress of the transfer operation. + # Output only. The progress of the transfer operation. # @!attribute [r] transfer_type # @return [::Google::Cloud::Parallelstore::V1beta::TransferType] # Output only. The type of transfer occurring. @@ -573,7 +575,7 @@ module TransferType # Represents the striping options for files. module FileStripeLevel - # Default file striping + # If not set, FileStripeLevel will default to FILE_STRIPE_LEVEL_BALANCED FILE_STRIPE_LEVEL_UNSPECIFIED = 0 # Minimum file striping @@ -588,7 +590,7 @@ module FileStripeLevel # Represents the striping options for directories. module DirectoryStripeLevel - # Default directory striping + # If not set, DirectoryStripeLevel will default to DIRECTORY_STRIPE_LEVEL_MAX DIRECTORY_STRIPE_LEVEL_UNSPECIFIED = 0 # Minimum directory striping