google-cloud-lustre-v1 0.a → 0.1.0

data/proto_docs/google/cloud/lustre/v1/transfer.rb

@@ -0,0 +1,284 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Lustre
+      module V1
+        # Message for importing data to Lustre.
+        # @!attribute [rw] gcs_path
+        #   @return [::Google::Cloud::Lustre::V1::GcsPath]
+        #     The Cloud Storage source bucket and, optionally, path inside the bucket.
+        # @!attribute [rw] lustre_path
+        #   @return [::Google::Cloud::Lustre::V1::LustrePath]
+        #     Lustre path destination.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. UUID to identify requests.
+        # @!attribute [rw] service_account
+        #   @return [::String]
+        #     Optional. User-specified service account used to perform the transfer.
+        #     If unspecified, the default Lustre P4 service account will be used.
+        class ImportDataRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message for exporting data from Lustre.
+        # @!attribute [rw] lustre_path
+        #   @return [::Google::Cloud::Lustre::V1::LustrePath]
+        #     Lustre path source.
+        # @!attribute [rw] gcs_path
+        #   @return [::Google::Cloud::Lustre::V1::GcsPath]
+        #     Cloud Storage destination.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Name of the resource.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. UUID to identify requests.
+        # @!attribute [rw] service_account
+        #   @return [::String]
+        #     Optional. User-specified service account used to perform the transfer.
+        #     If unspecified, the Managed Lustre service agent is used.
+        class ExportDataRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for ExportData.
+        class ExportDataResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for ImportData.
+        class ImportDataResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata of the export data operation.
+        # @!attribute [rw] operation_metadata
+        #   @return [::Google::Cloud::Lustre::V1::TransferOperationMetadata]
+        #     Data transfer operation metadata.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the operation was created.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the operation finished running.
+        # @!attribute [r] target
+        #   @return [::String]
+        #     Output only. Server-defined resource path for the target of the operation.
+        # @!attribute [r] verb
+        #   @return [::String]
+        #     Output only. Name of the verb executed by the operation.
+        # @!attribute [r] status_message
+        #   @return [::String]
+        #     Output only. Human-readable status of the operation, if any.
+        # @!attribute [r] requested_cancellation
+        #   @return [::Boolean]
+        #     Output only. Identifies whether the user has requested cancellation
+        #     of the operation. Operations that have successfully been cancelled
+        #     have
+        #     {::Google::Longrunning::Operation#error google.longrunning.Operation.error}
+        #     value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
+        #     corresponding to `Code.CANCELLED`.
+        # @!attribute [r] api_version
+        #   @return [::String]
+        #     Output only. API version used to start the operation.
+        class ExportDataMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata of the import data operation.
+        # @!attribute [rw] operation_metadata
+        #   @return [::Google::Cloud::Lustre::V1::TransferOperationMetadata]
+        #     Data transfer operation metadata.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the operation was created.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the operation finished running.
+        # @!attribute [r] target
+        #   @return [::String]
+        #     Output only. Server-defined resource path for the target of the operation.
+        # @!attribute [r] status_message
+        #   @return [::String]
+        #     Output only. Name of the verb executed by the operation.
+        # @!attribute [r] requested_cancellation
+        #   @return [::Boolean]
+        #     Output only. Identifies whether the user has requested cancellation
+        #     of the operation. Operations that have successfully been cancelled
+        #     have
+        #     {::Google::Longrunning::Operation#error google.longrunning.Operation.error}
+        #     value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
+        #     corresponding to `Code.CANCELLED`.
+        # @!attribute [r] api_version
+        #   @return [::String]
+        #     Output only. API version used to start the operation.
+        class ImportDataMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Cloud Storage as the source of a data transfer.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     Required. URI to a Cloud Storage path in the format:
+        #     `gs://<bucket_name>`.
+        class GcsPath
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # LustrePath represents a path in the Lustre file system.
+        # @!attribute [rw] path
+        #   @return [::String]
+        #     Optional. Root directory path to the Managed Lustre file system, starting
+        #     with `/`. Defaults to `/` if unset.
+        class LustrePath
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A collection of counters that report the progress of a transfer operation.
+        # @!attribute [rw] found_objects_count
+        #   @return [::Integer]
+        #     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.
+        # @!attribute [rw] bytes_found_count
+        #   @return [::Integer]
+        #     Total number of 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.
+        # @!attribute [rw] objects_skipped_count
+        #   @return [::Integer]
+        #     Objects in the data source that are not transferred because they already
+        #     exist in the data destination.
+        # @!attribute [rw] bytes_skipped_count
+        #   @return [::Integer]
+        #     Bytes in the data source that are not transferred because they already
+        #     exist in the data destination.
+        # @!attribute [rw] objects_copied_count
+        #   @return [::Integer]
+        #     Objects that are copied to the data destination.
+        # @!attribute [rw] bytes_copied_count
+        #   @return [::Integer]
+        #     Bytes that are copied to the data destination.
+        # @!attribute [r] objects_failed_count
+        #   @return [::Integer]
+        #     Output only. Objects that are failed to write to the data destination.
+        # @!attribute [r] bytes_failed_count
+        #   @return [::Integer]
+        #     Output only. Bytes that are failed to write to the data destination.
+        class TransferCounters
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An entry describing an error that has occurred.
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     Required. A URL that refers to the target (a data source, a data sink,
+        #     or an object) with which the error is associated.
+        # @!attribute [rw] error_details
+        #   @return [::Array<::String>]
+        #     A list of messages that carry the error details.
+        class ErrorLogEntry
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A summary of errors by error code, plus a count and sample error log
+        # entries.
+        # @!attribute [rw] error_code
+        #   @return [::Google::Rpc::Code]
+        #     Required.
+        # @!attribute [rw] error_count
+        #   @return [::Integer]
+        #     Required. Count of this type of error.
+        # @!attribute [rw] error_log_entries
+        #   @return [::Array<::Google::Cloud::Lustre::V1::ErrorLogEntry>]
+        #     Error samples.
+        #
+        #     At most 5 error log entries are recorded for a given
+        #     error code for a single transfer operation.
+        class ErrorSummary
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents the metadata of the long-running transfer operation.
+        # @!attribute [r] source_lustre_path
+        #   @return [::Google::Cloud::Lustre::V1::LustrePath]
+        #     Output only. Lustre source.
+        #
+        #     Note: The following fields are mutually exclusive: `source_lustre_path`, `source_gcs_path`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [r] source_gcs_path
+        #   @return [::Google::Cloud::Lustre::V1::GcsPath]
+        #     Output only. Cloud Storage source.
+        #
+        #     Note: The following fields are mutually exclusive: `source_gcs_path`, `source_lustre_path`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [r] destination_gcs_path
+        #   @return [::Google::Cloud::Lustre::V1::GcsPath]
+        #     Output only. Cloud Storage destination.
+        #
+        #     Note: The following fields are mutually exclusive: `destination_gcs_path`, `destination_lustre_path`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [r] destination_lustre_path
+        #   @return [::Google::Cloud::Lustre::V1::LustrePath]
+        #     Output only. Lustre destination.
+        #
+        #     Note: The following fields are mutually exclusive: `destination_lustre_path`, `destination_gcs_path`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [r] counters
+        #   @return [::Google::Cloud::Lustre::V1::TransferCounters]
+        #     Output only. The progress of the transfer operation.
+        # @!attribute [r] transfer_type
+        #   @return [::Google::Cloud::Lustre::V1::TransferType]
+        #     Output only. The type of transfer occurring.
+        # @!attribute [r] error_summaries
+        #   @return [::Array<::Google::Cloud::Lustre::V1::ErrorSummary>]
+        #     Output only. Error summary about the transfer operation
+        class TransferOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Type of transfer that occurred.
+        module TransferType
+          # Zero is an illegal value.
+          TRANSFER_TYPE_UNSPECIFIED = 0
+
+          # Imports to Lustre.
+          IMPORT = 1
+
+          # Exports from Lustre.
+          EXPORT = 2
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/longrunning/operations.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Longrunning
+    # This resource represents a long-running operation that is the result of a
+    # network API call.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The server-assigned name, which is only unique within the same service that
+    #     originally returns it. If you use the default HTTP mapping, the
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
+    # @!attribute [rw] metadata
+    #   @return [::Google::Protobuf::Any]
+    #     Service-specific metadata associated with the operation.  It typically
+    #     contains progress information and common metadata such as create time.
+    #     Some services might not provide such metadata.  Any method that returns a
+    #     long-running operation should document the metadata type, if any.
+    # @!attribute [rw] done
+    #   @return [::Boolean]
+    #     If the value is `false`, it means the operation is still in progress.
+    #     If `true`, the operation is completed, and either `error` or `response` is
+    #     available.
+    # @!attribute [rw] error
+    #   @return [::Google::Rpc::Status]
+    #     The error result of the operation in case of failure or cancellation.
+    #
+    #     Note: The following fields are mutually exclusive: `error`, `response`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+    # @!attribute [rw] response
+    #   @return [::Google::Protobuf::Any]
+    #     The normal, successful response of the operation.  If the original
+    #     method returns no data on success, such as `Delete`, the response is
+    #     `google.protobuf.Empty`.  If the original method is standard
+    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
+    #     methods, the response should have the type `XxxResponse`, where `Xxx`
+    #     is the original method name.  For example, if the original method name
+    #     is `TakeSnapshot()`, the inferred response type is
+    #     `TakeSnapshotResponse`.
+    #
+    #     Note: The following fields are mutually exclusive: `response`, `error`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+    class Operation
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for
+    # Operations.GetOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource.
+    class GetOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for
+    # Operations.ListOperations.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation's parent resource.
+    # @!attribute [rw] filter
+    #   @return [::String]
+    #     The standard list filter.
+    # @!attribute [rw] page_size
+    #   @return [::Integer]
+    #     The standard list page size.
+    # @!attribute [rw] page_token
+    #   @return [::String]
+    #     The standard list page token.
+    class ListOperationsRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The response message for
+    # Operations.ListOperations.
+    # @!attribute [rw] operations
+    #   @return [::Array<::Google::Longrunning::Operation>]
+    #     A list of operations that matches the specified filter in the request.
+    # @!attribute [rw] next_page_token
+    #   @return [::String]
+    #     The standard List next-page token.
+    class ListOperationsResponse
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for
+    # Operations.CancelOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be cancelled.
+    class CancelOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for
+    # Operations.DeleteOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to be deleted.
+    class DeleteOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for
+    # Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     The maximum duration to wait before timing out. If left blank, the wait
+    #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+    #     If RPC context deadline is also specified, the shorter one will be used.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A message representing the message types used by a long-running operation.
+    #
+    # Example:
+    #
+    #     rpc Export(ExportRequest) returns (google.longrunning.Operation) {
+    #       option (google.longrunning.operation_info) = {
+    #         response_type: "ExportResponse"
+    #         metadata_type: "ExportMetadata"
+    #       };
+    #     }
+    # @!attribute [rw] response_type
+    #   @return [::String]
+    #     Required. The message name of the primary return type for this
+    #     long-running operation.
+    #     This type will be used to deserialize the LRO's response.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    # @!attribute [rw] metadata_type
+    #   @return [::String]
+    #     Required. The message name of the metadata type for this long-running
+    #     operation.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    class OperationInfo
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/any.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # `Any` contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #     // or ...
+    #     if (any.isSameTypeAs(Foo.getDefaultInstance())) {
+    #       foo = any.unpack(Foo.getDefaultInstance());
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := any.UnmarshalTo(foo); err != nil {
+    #        ...
+    #      }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    # JSON
+    # ====
+    # The JSON representation of an `Any` value uses the regular
+    # representation of the deserialized, embedded message, with an
+    # additional field `@type` which contains the type URL. Example:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # `value` which holds the custom JSON in addition to the `@type`
+    # field. Example (for message [google.protobuf.Duration][]):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [::String]
+    #     A URL/resource name that uniquely identifies the type of the serialized
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
+    #     the fully qualified name of the type (as in
+    #     `path/google.protobuf.Duration`). The name should be in a canonical form
+    #     (e.g., leading "." is not accepted).
+    #
+    #     In practice, teams usually precompile into the binary all types that they
+    #     expect it to use in the context of Any. However, for URLs which use the
+    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
+    #     server that maps type URLs to message definitions as follows:
+    #
+    #     * If no scheme is provided, `https` is assumed.
+    #     * An HTTP GET on the URL must yield a [google.protobuf.Type][]
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Note: this functionality is not currently available in the official
+    #     protobuf release, and it is not used for type URLs beginning with
+    #     type.googleapis.com. As of May 2023, there are no widely used type server
+    #     implementations and no plans to implement one.
+    #
+    #     Schemes other than `http`, `https` (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [::String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end