lib/google/cloud/parallelstore/v1beta/parallelstore/client.rb in google-cloud-parallelstore-v1beta-0.3.1 vs lib/google/cloud/parallelstore/v1beta/parallelstore/client.rb in google-cloud-parallelstore-v1beta-0.4.0

- old
+ new

@@ -205,11 +205,11 @@ attr_reader :location_client # 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 # {::Google::Cloud::Parallelstore::V1beta::ListInstancesRequest} or an equivalent Hash. # @@ -225,23 +225,22 @@ # the default parameter values, pass an empty Hash as a request object (see above). # # @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>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # @@ -310,11 +309,11 @@ rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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 # {::Google::Cloud::Parallelstore::V1beta::GetInstanceRequest} or an equivalent Hash. # @@ -417,14 +416,13 @@ # the default parameter values, pass an empty Hash as a request object (see above). # # @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. # * Must be between 1-63 characters. # * Must end with a number or a letter. @@ -518,11 +516,11 @@ rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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 # {::Google::Cloud::Parallelstore::V1beta::UpdateInstanceRequest} or an equivalent Hash. # @@ -536,16 +534,16 @@ # Pass arguments to `update_instance` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # 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 # ignore the request if it has already been completed. The server will # guarantee that for at least 60 minutes since the first request. @@ -631,11 +629,11 @@ rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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 # {::Google::Cloud::Parallelstore::V1beta::DeleteInstanceRequest} or an equivalent Hash. # @@ -739,11 +737,11 @@ rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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 # {::Google::Cloud::Parallelstore::V1beta::ImportDataRequest} or an equivalent Hash. # @@ -757,11 +755,11 @@ # Pass arguments to `import_data` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # 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] # Required. Name of the resource. # @param request_id [::String] @@ -777,15 +775,21 @@ # 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). # @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-<PROJECT_NUMBER>@gcp-sa-parallelstore.iam.gserviceaccount.com) + # `service-<PROJECT_NUMBER>@gcp-sa-parallelstore.iam.gserviceaccount.com` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # @@ -857,11 +861,11 @@ rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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 # {::Google::Cloud::Parallelstore::V1beta::ExportDataRequest} or an equivalent Hash. # @@ -897,12 +901,17 @@ # 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 # 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-<PROJECT_NUMBER>@gcp-sa-parallelstore.iam.gserviceaccount.com) + # `service-<PROJECT_NUMBER>@gcp-sa-parallelstore.iam.gserviceaccount.com` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] #