google-cloud-storage_transfer-v1 0.1.0

data/lib/google/cloud/storage_transfer/v1/version.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 StorageTransfer
+      module V1
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/lib/google/storagetransfer/v1/transfer_pb.rb

@@ -0,0 +1,70 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/storagetransfer/v1/transfer.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/longrunning/operations_pb'
+require 'google/protobuf/duration_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/storagetransfer/v1/transfer_types_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/storagetransfer/v1/transfer.proto", :syntax => :proto3) do
+    add_message "google.storagetransfer.v1.GetGoogleServiceAccountRequest" do
+      optional :project_id, :string, 1
+    end
+    add_message "google.storagetransfer.v1.CreateTransferJobRequest" do
+      optional :transfer_job, :message, 1, "google.storagetransfer.v1.TransferJob"
+    end
+    add_message "google.storagetransfer.v1.UpdateTransferJobRequest" do
+      optional :job_name, :string, 1
+      optional :project_id, :string, 2
+      optional :transfer_job, :message, 3, "google.storagetransfer.v1.TransferJob"
+      optional :update_transfer_job_field_mask, :message, 4, "google.protobuf.FieldMask"
+    end
+    add_message "google.storagetransfer.v1.GetTransferJobRequest" do
+      optional :job_name, :string, 1
+      optional :project_id, :string, 2
+    end
+    add_message "google.storagetransfer.v1.ListTransferJobsRequest" do
+      optional :filter, :string, 1
+      optional :page_size, :int32, 4
+      optional :page_token, :string, 5
+    end
+    add_message "google.storagetransfer.v1.ListTransferJobsResponse" do
+      repeated :transfer_jobs, :message, 1, "google.storagetransfer.v1.TransferJob"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.storagetransfer.v1.PauseTransferOperationRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.storagetransfer.v1.ResumeTransferOperationRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.storagetransfer.v1.RunTransferJobRequest" do
+      optional :job_name, :string, 1
+      optional :project_id, :string, 2
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module StorageTransfer
+      module V1
+        GetGoogleServiceAccountRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.GetGoogleServiceAccountRequest").msgclass
+        CreateTransferJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.CreateTransferJobRequest").msgclass
+        UpdateTransferJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.UpdateTransferJobRequest").msgclass
+        GetTransferJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.GetTransferJobRequest").msgclass
+        ListTransferJobsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.ListTransferJobsRequest").msgclass
+        ListTransferJobsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.ListTransferJobsResponse").msgclass
+        PauseTransferOperationRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.PauseTransferOperationRequest").msgclass
+        ResumeTransferOperationRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.ResumeTransferOperationRequest").msgclass
+        RunTransferJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.RunTransferJobRequest").msgclass
+      end
+    end
+  end
+end

data/lib/google/storagetransfer/v1/transfer_services_pb.rb

@@ -0,0 +1,77 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/storagetransfer/v1/transfer.proto for package 'Google.Cloud.StorageTransfer.V1'
+# Original file comments:
+# Copyright 2021 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
+#
+#     http://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.
+#
+
+require 'grpc'
+require 'google/storagetransfer/v1/transfer_pb'
+
+module Google
+  module Cloud
+    module StorageTransfer
+      module V1
+        module StorageTransferService
+          # Storage Transfer Service and its protos.
+          # Transfers data between between Google Cloud Storage buckets or from a data
+          # source external to Google to a Cloud Storage bucket.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.storagetransfer.v1.StorageTransferService'
+
+            # Returns the Google service account that is used by Storage Transfer
+            # Service to access buckets in the project where transfers
+            # run or in other projects. Each Google service account is associated
+            # with one Google Cloud Platform Console project. Users
+            # should add this service account to the Google Cloud Storage bucket
+            # ACLs to grant access to Storage Transfer Service. This service
+            # account is created and owned by Storage Transfer Service and can
+            # only be used by Storage Transfer Service.
+            rpc :GetGoogleServiceAccount, ::Google::Cloud::StorageTransfer::V1::GetGoogleServiceAccountRequest, ::Google::Cloud::StorageTransfer::V1::GoogleServiceAccount
+            # Creates a transfer job that runs periodically.
+            rpc :CreateTransferJob, ::Google::Cloud::StorageTransfer::V1::CreateTransferJobRequest, ::Google::Cloud::StorageTransfer::V1::TransferJob
+            # Updates a transfer job. Updating a job's transfer spec does not affect
+            # transfer operations that are running already.
+            #
+            # **Note:** The job's [status][google.storagetransfer.v1.TransferJob.status]
+            # field can be modified using this RPC (for example, to set a job's status to
+            # [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED],
+            # [DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED], or
+            # [ENABLED][google.storagetransfer.v1.TransferJob.Status.ENABLED]).
+            rpc :UpdateTransferJob, ::Google::Cloud::StorageTransfer::V1::UpdateTransferJobRequest, ::Google::Cloud::StorageTransfer::V1::TransferJob
+            # Gets a transfer job.
+            rpc :GetTransferJob, ::Google::Cloud::StorageTransfer::V1::GetTransferJobRequest, ::Google::Cloud::StorageTransfer::V1::TransferJob
+            # Lists transfer jobs.
+            rpc :ListTransferJobs, ::Google::Cloud::StorageTransfer::V1::ListTransferJobsRequest, ::Google::Cloud::StorageTransfer::V1::ListTransferJobsResponse
+            # Pauses a transfer operation.
+            rpc :PauseTransferOperation, ::Google::Cloud::StorageTransfer::V1::PauseTransferOperationRequest, ::Google::Protobuf::Empty
+            # Resumes a transfer operation that is paused.
+            rpc :ResumeTransferOperation, ::Google::Cloud::StorageTransfer::V1::ResumeTransferOperationRequest, ::Google::Protobuf::Empty
+            # Attempts to start a new TransferOperation for the current TransferJob. A
+            # TransferJob has a maximum of one active TransferOperation. If this method
+            # is called while a TransferOperation is active, an error wil be returned.
+            rpc :RunTransferJob, ::Google::Cloud::StorageTransfer::V1::RunTransferJobRequest, ::Google::Longrunning::Operation
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/storagetransfer/v1/transfer_types_pb.rb

@@ -0,0 +1,193 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/storagetransfer/v1/transfer_types.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/field_behavior_pb'
+require 'google/protobuf/any_pb'
+require 'google/protobuf/duration_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/rpc/code_pb'
+require 'google/type/date_pb'
+require 'google/type/timeofday_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/storagetransfer/v1/transfer_types.proto", :syntax => :proto3) do
+    add_message "google.storagetransfer.v1.GoogleServiceAccount" do
+      optional :account_email, :string, 1
+      optional :subject_id, :string, 2
+    end
+    add_message "google.storagetransfer.v1.AwsAccessKey" do
+      optional :access_key_id, :string, 1
+      optional :secret_access_key, :string, 2
+    end
+    add_message "google.storagetransfer.v1.AzureCredentials" do
+      optional :sas_token, :string, 2
+    end
+    add_message "google.storagetransfer.v1.ObjectConditions" do
+      optional :min_time_elapsed_since_last_modification, :message, 1, "google.protobuf.Duration"
+      optional :max_time_elapsed_since_last_modification, :message, 2, "google.protobuf.Duration"
+      repeated :include_prefixes, :string, 3
+      repeated :exclude_prefixes, :string, 4
+      optional :last_modified_since, :message, 5, "google.protobuf.Timestamp"
+      optional :last_modified_before, :message, 6, "google.protobuf.Timestamp"
+    end
+    add_message "google.storagetransfer.v1.GcsData" do
+      optional :bucket_name, :string, 1
+      optional :path, :string, 3
+    end
+    add_message "google.storagetransfer.v1.AwsS3Data" do
+      optional :bucket_name, :string, 1
+      optional :aws_access_key, :message, 2, "google.storagetransfer.v1.AwsAccessKey"
+      optional :path, :string, 3
+      optional :role_arn, :string, 4
+    end
+    add_message "google.storagetransfer.v1.AzureBlobStorageData" do
+      optional :storage_account, :string, 1
+      optional :azure_credentials, :message, 2, "google.storagetransfer.v1.AzureCredentials"
+      optional :container, :string, 4
+      optional :path, :string, 5
+    end
+    add_message "google.storagetransfer.v1.HttpData" do
+      optional :list_url, :string, 1
+    end
+    add_message "google.storagetransfer.v1.TransferOptions" do
+      optional :overwrite_objects_already_existing_in_sink, :bool, 1
+      optional :delete_objects_unique_in_sink, :bool, 2
+      optional :delete_objects_from_source_after_transfer, :bool, 3
+    end
+    add_message "google.storagetransfer.v1.TransferSpec" do
+      optional :object_conditions, :message, 5, "google.storagetransfer.v1.ObjectConditions"
+      optional :transfer_options, :message, 6, "google.storagetransfer.v1.TransferOptions"
+      oneof :data_sink do
+        optional :gcs_data_sink, :message, 4, "google.storagetransfer.v1.GcsData"
+      end
+      oneof :data_source do
+        optional :gcs_data_source, :message, 1, "google.storagetransfer.v1.GcsData"
+        optional :aws_s3_data_source, :message, 2, "google.storagetransfer.v1.AwsS3Data"
+        optional :http_data_source, :message, 3, "google.storagetransfer.v1.HttpData"
+        optional :azure_blob_storage_data_source, :message, 8, "google.storagetransfer.v1.AzureBlobStorageData"
+      end
+    end
+    add_message "google.storagetransfer.v1.Schedule" do
+      optional :schedule_start_date, :message, 1, "google.type.Date"
+      optional :schedule_end_date, :message, 2, "google.type.Date"
+      optional :start_time_of_day, :message, 3, "google.type.TimeOfDay"
+      optional :end_time_of_day, :message, 4, "google.type.TimeOfDay"
+      optional :repeat_interval, :message, 5, "google.protobuf.Duration"
+    end
+    add_message "google.storagetransfer.v1.TransferJob" do
+      optional :name, :string, 1
+      optional :description, :string, 2
+      optional :project_id, :string, 3
+      optional :transfer_spec, :message, 4, "google.storagetransfer.v1.TransferSpec"
+      optional :notification_config, :message, 11, "google.storagetransfer.v1.NotificationConfig"
+      optional :schedule, :message, 5, "google.storagetransfer.v1.Schedule"
+      optional :status, :enum, 6, "google.storagetransfer.v1.TransferJob.Status"
+      optional :creation_time, :message, 7, "google.protobuf.Timestamp"
+      optional :last_modification_time, :message, 8, "google.protobuf.Timestamp"
+      optional :deletion_time, :message, 9, "google.protobuf.Timestamp"
+      optional :latest_operation_name, :string, 12
+    end
+    add_enum "google.storagetransfer.v1.TransferJob.Status" do
+      value :STATUS_UNSPECIFIED, 0
+      value :ENABLED, 1
+      value :DISABLED, 2
+      value :DELETED, 3
+    end
+    add_message "google.storagetransfer.v1.ErrorLogEntry" do
+      optional :url, :string, 1
+      repeated :error_details, :string, 3
+    end
+    add_message "google.storagetransfer.v1.ErrorSummary" do
+      optional :error_code, :enum, 1, "google.rpc.Code"
+      optional :error_count, :int64, 2
+      repeated :error_log_entries, :message, 3, "google.storagetransfer.v1.ErrorLogEntry"
+    end
+    add_message "google.storagetransfer.v1.TransferCounters" do
+      optional :objects_found_from_source, :int64, 1
+      optional :bytes_found_from_source, :int64, 2
+      optional :objects_found_only_from_sink, :int64, 3
+      optional :bytes_found_only_from_sink, :int64, 4
+      optional :objects_from_source_skipped_by_sync, :int64, 5
+      optional :bytes_from_source_skipped_by_sync, :int64, 6
+      optional :objects_copied_to_sink, :int64, 7
+      optional :bytes_copied_to_sink, :int64, 8
+      optional :objects_deleted_from_source, :int64, 9
+      optional :bytes_deleted_from_source, :int64, 10
+      optional :objects_deleted_from_sink, :int64, 11
+      optional :bytes_deleted_from_sink, :int64, 12
+      optional :objects_from_source_failed, :int64, 13
+      optional :bytes_from_source_failed, :int64, 14
+      optional :objects_failed_to_delete_from_sink, :int64, 15
+      optional :bytes_failed_to_delete_from_sink, :int64, 16
+    end
+    add_message "google.storagetransfer.v1.NotificationConfig" do
+      optional :pubsub_topic, :string, 1
+      repeated :event_types, :enum, 2, "google.storagetransfer.v1.NotificationConfig.EventType"
+      optional :payload_format, :enum, 3, "google.storagetransfer.v1.NotificationConfig.PayloadFormat"
+    end
+    add_enum "google.storagetransfer.v1.NotificationConfig.EventType" do
+      value :EVENT_TYPE_UNSPECIFIED, 0
+      value :TRANSFER_OPERATION_SUCCESS, 1
+      value :TRANSFER_OPERATION_FAILED, 2
+      value :TRANSFER_OPERATION_ABORTED, 3
+    end
+    add_enum "google.storagetransfer.v1.NotificationConfig.PayloadFormat" do
+      value :PAYLOAD_FORMAT_UNSPECIFIED, 0
+      value :NONE, 1
+      value :JSON, 2
+    end
+    add_message "google.storagetransfer.v1.TransferOperation" do
+      optional :name, :string, 1
+      optional :project_id, :string, 2
+      optional :transfer_spec, :message, 3, "google.storagetransfer.v1.TransferSpec"
+      optional :notification_config, :message, 10, "google.storagetransfer.v1.NotificationConfig"
+      optional :start_time, :message, 4, "google.protobuf.Timestamp"
+      optional :end_time, :message, 5, "google.protobuf.Timestamp"
+      optional :status, :enum, 6, "google.storagetransfer.v1.TransferOperation.Status"
+      optional :counters, :message, 7, "google.storagetransfer.v1.TransferCounters"
+      repeated :error_breakdowns, :message, 8, "google.storagetransfer.v1.ErrorSummary"
+      optional :transfer_job_name, :string, 9
+    end
+    add_enum "google.storagetransfer.v1.TransferOperation.Status" do
+      value :STATUS_UNSPECIFIED, 0
+      value :IN_PROGRESS, 1
+      value :PAUSED, 2
+      value :SUCCESS, 3
+      value :FAILED, 4
+      value :ABORTED, 5
+      value :QUEUED, 6
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module StorageTransfer
+      module V1
+        GoogleServiceAccount = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.GoogleServiceAccount").msgclass
+        AwsAccessKey = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.AwsAccessKey").msgclass
+        AzureCredentials = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.AzureCredentials").msgclass
+        ObjectConditions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.ObjectConditions").msgclass
+        GcsData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.GcsData").msgclass
+        AwsS3Data = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.AwsS3Data").msgclass
+        AzureBlobStorageData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.AzureBlobStorageData").msgclass
+        HttpData = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.HttpData").msgclass
+        TransferOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.TransferOptions").msgclass
+        TransferSpec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.TransferSpec").msgclass
+        Schedule = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.Schedule").msgclass
+        TransferJob = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.TransferJob").msgclass
+        TransferJob::Status = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.TransferJob.Status").enummodule
+        ErrorLogEntry = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.ErrorLogEntry").msgclass
+        ErrorSummary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.ErrorSummary").msgclass
+        TransferCounters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.TransferCounters").msgclass
+        NotificationConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.NotificationConfig").msgclass
+        NotificationConfig::EventType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.NotificationConfig.EventType").enummodule
+        NotificationConfig::PayloadFormat = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.NotificationConfig.PayloadFormat").enummodule
+        TransferOperation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.TransferOperation").msgclass
+        TransferOperation::Status = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.storagetransfer.v1.TransferOperation.Status").enummodule
+      end
+    end
+  end
+end

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Storage Transfer Service V1 Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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 Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary  order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
+    end
+  end
+end