# 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
# Google service account
# @!attribute [rw] account_email
# @return [::String]
# Email address of the service account.
# @!attribute [rw] subject_id
# @return [::String]
# Unique identifier for the service account.
class GoogleServiceAccount
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# AWS access key (see
# [AWS Security
# Credentials](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).
#
# For information on our data retention policy for user credentials, see
# [User credentials](/storage-transfer/docs/data-retention#user-credentials).
# @!attribute [rw] access_key_id
# @return [::String]
# Required. AWS access key ID.
# @!attribute [rw] secret_access_key
# @return [::String]
# Required. AWS secret access key. This field is not returned in RPC
# responses.
class AwsAccessKey
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Azure credentials
#
# For information on our data retention policy for user credentials, see
# [User credentials](/storage-transfer/docs/data-retention#user-credentials).
# @!attribute [rw] sas_token
# @return [::String]
# Required. Azure shared access signature (SAS).
#
# For more information about SAS, see
# [Grant limited access to Azure Storage resources using shared access
# signatures
# (SAS)](https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview).
class AzureCredentials
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Conditions that determine which objects are transferred. Applies only
# to Cloud Data Sources such as S3, Azure, and Cloud Storage.
#
# The "last modification time" refers to the time of the
# last change to the object's content or metadata — specifically, this is
# the `updated` property of Cloud Storage objects, the `LastModified` field
# of S3 objects, and the `Last-Modified` header of Azure blobs.
#
# Transfers with a {::Google::Cloud::StorageTransfer::V1::PosixFilesystem PosixFilesystem} source or destination don't support
# `ObjectConditions`.
# @!attribute [rw] min_time_elapsed_since_last_modification
# @return [::Google::Protobuf::Duration]
# Ensures that objects are not transferred until a specific minimum time
# has elapsed after the "last modification time". When a
# {::Google::Cloud::StorageTransfer::V1::TransferOperation TransferOperation} begins, objects with a "last modification time" are
# transferred only if the elapsed time between the
# {::Google::Cloud::StorageTransfer::V1::TransferOperation#start_time start_time} of the `TransferOperation`
# and the "last modification time" of the object is equal to or
# greater than the value of min_time_elapsed_since_last_modification`.
# Objects that do not have a "last modification time" are also transferred.
# @!attribute [rw] max_time_elapsed_since_last_modification
# @return [::Google::Protobuf::Duration]
# Ensures that objects are not transferred if a specific maximum time
# has elapsed since the "last modification time".
# When a {::Google::Cloud::StorageTransfer::V1::TransferOperation TransferOperation} begins, objects with a
# "last modification time" are transferred only if the elapsed time
# between the {::Google::Cloud::StorageTransfer::V1::TransferOperation#start_time start_time} of the
# `TransferOperation`and the "last modification time" of the object
# is less than the value of max_time_elapsed_since_last_modification`.
# Objects that do not have a "last modification time" are also transferred.
# @!attribute [rw] include_prefixes
# @return [::Array<::String>]
# If you specify `include_prefixes`, Storage Transfer Service uses the items
# in the `include_prefixes` array to determine which objects to include in a
# transfer. Objects must start with one of the matching `include_prefixes`
# for inclusion in the transfer. If {::Google::Cloud::StorageTransfer::V1::ObjectConditions#exclude_prefixes exclude_prefixes} is specified,
# objects must not start with any of the `exclude_prefixes` specified for
# inclusion in the transfer.
#
# The following are requirements of `include_prefixes`:
#
# * Each include-prefix can contain any sequence of Unicode characters, to
# a max length of 1024 bytes when UTF8-encoded, and must not contain
# Carriage Return or Line Feed characters. Wildcard matching and regular
# expression matching are not supported.
#
# * Each include-prefix must omit the leading slash. For example, to
# include the object `s3://my-aws-bucket/logs/y=2015/requests.gz`,
# specify the include-prefix as `logs/y=2015/requests.gz`.
#
# * None of the include-prefix values can be empty, if specified.
#
# * Each include-prefix must include a distinct portion of the object
# namespace. No include-prefix may be a prefix of another
# include-prefix.
#
# The max size of `include_prefixes` is 1000.
#
# For more information, see [Filtering objects from
# transfers](/storage-transfer/docs/filtering-objects-from-transfers).
# @!attribute [rw] exclude_prefixes
# @return [::Array<::String>]
# If you specify `exclude_prefixes`, Storage Transfer Service uses the items
# in the `exclude_prefixes` array to determine which objects to exclude from
# a transfer. Objects must not start with one of the matching
# `exclude_prefixes` for inclusion in a transfer.
#
# The following are requirements of `exclude_prefixes`:
#
# * Each exclude-prefix can contain any sequence of Unicode characters, to
# a max length of 1024 bytes when UTF8-encoded, and must not contain
# Carriage Return or Line Feed characters. Wildcard matching and regular
# expression matching are not supported.
#
# * Each exclude-prefix must omit the leading slash. For example, to
# exclude the object `s3://my-aws-bucket/logs/y=2015/requests.gz`,
# specify the exclude-prefix as `logs/y=2015/requests.gz`.
#
# * None of the exclude-prefix values can be empty, if specified.
#
# * Each exclude-prefix must exclude a distinct portion of the object
# namespace. No exclude-prefix may be a prefix of another
# exclude-prefix.
#
# * If {::Google::Cloud::StorageTransfer::V1::ObjectConditions#include_prefixes include_prefixes} is specified, then each exclude-prefix must
# start with the value of a path explicitly included by `include_prefixes`.
#
# The max size of `exclude_prefixes` is 1000.
#
# For more information, see [Filtering objects from
# transfers](/storage-transfer/docs/filtering-objects-from-transfers).
# @!attribute [rw] last_modified_since
# @return [::Google::Protobuf::Timestamp]
# If specified, only objects with a "last modification time" on or after
# this timestamp and objects that don't have a "last modification time" are
# transferred.
#
# The `last_modified_since` and `last_modified_before` fields can be used
# together for chunked data processing. For example, consider a script that
# processes each day's worth of data at a time. For that you'd set each
# of the fields as follows:
#
# * `last_modified_since` to the start of the day
#
# * `last_modified_before` to the end of the day
# @!attribute [rw] last_modified_before
# @return [::Google::Protobuf::Timestamp]
# If specified, only objects with a "last modification time" before this
# timestamp and objects that don't have a "last modification time" are
# transferred.
class ObjectConditions
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# In a GcsData resource, an object's name is the Cloud Storage object's
# name and its "last modification time" refers to the object's `updated`
# property of Cloud Storage objects, which changes when the content or the
# metadata of the object is updated.
# @!attribute [rw] bucket_name
# @return [::String]
# Required. Cloud Storage bucket name. Must meet
# [Bucket Name Requirements](/storage/docs/naming#requirements).
# @!attribute [rw] path
# @return [::String]
# Root path to transfer objects.
#
# Must be an empty string or full path name that ends with a '/'. This field
# is treated as an object prefix. As such, it should generally not begin with
# a '/'.
#
# The root path value must meet
# [Object Name Requirements](/storage/docs/naming#objectnames).
class GcsData
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# An AwsS3Data resource can be a data source, but not a data sink.
# In an AwsS3Data resource, an object's name is the S3 object's key name.
# @!attribute [rw] bucket_name
# @return [::String]
# Required. S3 Bucket name (see
# [Creating a
# bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).
# @!attribute [rw] aws_access_key
# @return [::Google::Cloud::StorageTransfer::V1::AwsAccessKey]
# Input only. AWS access key used to sign the API requests to the AWS S3 bucket.
# Permissions on the bucket must be granted to the access ID of the AWS
# access key.
#
# For information on our data retention policy for user credentials, see
# [User credentials](/storage-transfer/docs/data-retention#user-credentials).
# @!attribute [rw] path
# @return [::String]
# Root path to transfer objects.
#
# Must be an empty string or full path name that ends with a '/'. This field
# is treated as an object prefix. As such, it should generally not begin with
# a '/'.
# @!attribute [rw] role_arn
# @return [::String]
# The Amazon Resource Name (ARN) of the role to support temporary
# credentials via `AssumeRoleWithWebIdentity`. For more information about
# ARNs, see [IAM
# ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns).
#
# When a role ARN is provided, Transfer Service fetches temporary
# credentials for the session using a `AssumeRoleWithWebIdentity` call for
# the provided role using the {::Google::Cloud::StorageTransfer::V1::GoogleServiceAccount GoogleServiceAccount} for this project.
class AwsS3Data
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# An AzureBlobStorageData resource can be a data source, but not a data sink.
# An AzureBlobStorageData resource represents one Azure container. The storage
# account determines the [Azure
# endpoint](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account#storage-account-endpoints).
# In an AzureBlobStorageData resource, a blobs's name is the [Azure Blob
# Storage blob's key
# name](https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata#blob-names).
# @!attribute [rw] storage_account
# @return [::String]
# Required. The name of the Azure Storage account.
# @!attribute [rw] azure_credentials
# @return [::Google::Cloud::StorageTransfer::V1::AzureCredentials]
# Required. Input only. Credentials used to authenticate API requests to Azure.
#
# For information on our data retention policy for user credentials, see
# [User credentials](/storage-transfer/docs/data-retention#user-credentials).
# @!attribute [rw] container
# @return [::String]
# Required. The container to transfer from the Azure Storage account.
# @!attribute [rw] path
# @return [::String]
# Root path to transfer objects.
#
# Must be an empty string or full path name that ends with a '/'. This field
# is treated as an object prefix. As such, it should generally not begin with
# a '/'.
class AzureBlobStorageData
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# An HttpData resource specifies a list of objects on the web to be transferred
# over HTTP. The information of the objects to be transferred is contained in
# a file referenced by a URL. The first line in the file must be
# `"TsvHttpData-1.0"`, which specifies the format of the file. Subsequent
# lines specify the information of the list of objects, one object per list
# entry. Each entry has the following tab-delimited fields:
#
# * **HTTP URL** — The location of the object.
#
# * **Length** — The size of the object in bytes.
#
# * **MD5** — The base64-encoded MD5 hash of the object.
#
# For an example of a valid TSV file, see
# [Transferring data from
# URLs](https://cloud.google.com/storage-transfer/docs/create-url-list).
#
# When transferring data based on a URL list, keep the following in mind:
#
# * When an object located at `http(s)://hostname:port/<URL-path>` is
# transferred to a data sink, the name of the object at the data sink is
# `<hostname>/<URL-path>`.
#
# * If the specified size of an object does not match the actual size of the
# object fetched, the object is not transferred.
#
# * If the specified MD5 does not match the MD5 computed from the transferred
# bytes, the object transfer fails.
#
# * Ensure that each URL you specify is publicly accessible. For
# example, in Cloud Storage you can
# [share an object publicly]
# (/storage/docs/cloud-console#_sharingdata) and get a link to it.
#
# * Storage Transfer Service obeys `robots.txt` rules and requires the source
# HTTP server to support `Range` requests and to return a `Content-Length`
# header in each response.
#
# * {::Google::Cloud::StorageTransfer::V1::ObjectConditions ObjectConditions} have no effect when filtering objects to transfer.
# @!attribute [rw] list_url
# @return [::String]
# Required. The URL that points to the file that stores the object list
# entries. This file must allow public access. Currently, only URLs with
# HTTP and HTTPS schemes are supported.
class HttpData
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# A POSIX filesystem resource.
# @!attribute [rw] root_directory
# @return [::String]
# Root directory path to the filesystem.
class PosixFilesystem
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Represents an On-Premises Agent pool.
# @!attribute [rw] name
# @return [::String]
# Required. Specifies a unique string that identifies the agent pool.
#
# Format: `projects/{project_id}/agentPools/{agent_pool_id}`
# @!attribute [rw] display_name
# @return [::String]
# Specifies the client-specified AgentPool description.
# @!attribute [r] state
# @return [::Google::Cloud::StorageTransfer::V1::AgentPool::State]
# Output only. Specifies the state of the AgentPool.
# @!attribute [rw] bandwidth_limit
# @return [::Google::Cloud::StorageTransfer::V1::AgentPool::BandwidthLimit]
# Specifies the bandwidth limit details. If this field is unspecified, the
# default value is set as 'No Limit'.
class AgentPool
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# Specifies a bandwidth limit for an agent pool.
# @!attribute [rw] limit_mbps
# @return [::Integer]
# Bandwidth rate in megabytes per second, distributed across all the agents
# in the pool.
class BandwidthLimit
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# The state of an AgentPool.
module State
# Default value. This value is unused.
STATE_UNSPECIFIED = 0
# This is an initialization state. During this stage, the resources such as
# Pub/Sub topics are allocated for the AgentPool.
CREATING = 1
# Determines that the AgentPool is created for use. At this state, Agents
# can join the AgentPool and participate in the transfer jobs in that pool.
CREATED = 2
# Determines that the AgentPool deletion has been initiated, and all the
# resources are scheduled to be cleaned up and freed.
DELETING = 3
end
end
# TransferOptions define the actions to be performed on objects in a transfer.
# @!attribute [rw] overwrite_objects_already_existing_in_sink
# @return [::Boolean]
# When to overwrite objects that already exist in the sink. The default is
# that only objects that are different from the source are ovewritten. If
# true, all objects in the sink whose name matches an object in the source
# are overwritten with the source object.
# @!attribute [rw] delete_objects_unique_in_sink
# @return [::Boolean]
# Whether objects that exist only in the sink should be deleted.
#
# **Note:** This option and {::Google::Cloud::StorageTransfer::V1::TransferOptions#delete_objects_from_source_after_transfer delete_objects_from_source_after_transfer} are
# mutually exclusive.
# @!attribute [rw] delete_objects_from_source_after_transfer
# @return [::Boolean]
# Whether objects should be deleted from the source after they are
# transferred to the sink.
#
# **Note:** This option and {::Google::Cloud::StorageTransfer::V1::TransferOptions#delete_objects_unique_in_sink delete_objects_unique_in_sink} are mutually
# exclusive.
# @!attribute [rw] overwrite_when
# @return [::Google::Cloud::StorageTransfer::V1::TransferOptions::OverwriteWhen]
# When to overwrite objects that already exist in the sink. If not set
# overwrite behavior is determined by
# {::Google::Cloud::StorageTransfer::V1::TransferOptions#overwrite_objects_already_existing_in_sink overwrite_objects_already_existing_in_sink}.
# @!attribute [rw] metadata_options
# @return [::Google::Cloud::StorageTransfer::V1::MetadataOptions]
# Represents the selected metadata options for a transfer job. This feature
# is in Preview.
class TransferOptions
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# Specifies when to overwrite an object in the sink when an object with
# matching name is found in the source.
module OverwriteWhen
# Indicate the option is not set.
OVERWRITE_WHEN_UNSPECIFIED = 0
# Overwrite destination object with source if the two objects are
# different.
DIFFERENT = 1
# Never overwrite destination object.
NEVER = 2
# Always overwrite destination object.
ALWAYS = 3
end
end
# Configuration for running a transfer.
# @!attribute [rw] gcs_data_sink
# @return [::Google::Cloud::StorageTransfer::V1::GcsData]
# A Cloud Storage data sink.
# @!attribute [rw] posix_data_sink
# @return [::Google::Cloud::StorageTransfer::V1::PosixFilesystem]
# A POSIX Filesystem data sink.
# @!attribute [rw] gcs_data_source
# @return [::Google::Cloud::StorageTransfer::V1::GcsData]
# A Cloud Storage data source.
# @!attribute [rw] aws_s3_data_source
# @return [::Google::Cloud::StorageTransfer::V1::AwsS3Data]
# An AWS S3 data source.
# @!attribute [rw] http_data_source
# @return [::Google::Cloud::StorageTransfer::V1::HttpData]
# An HTTP URL data source.
# @!attribute [rw] posix_data_source
# @return [::Google::Cloud::StorageTransfer::V1::PosixFilesystem]
# A POSIX Filesystem data source.
# @!attribute [rw] azure_blob_storage_data_source
# @return [::Google::Cloud::StorageTransfer::V1::AzureBlobStorageData]
# An Azure Blob Storage data source.
# @!attribute [rw] gcs_intermediate_data_location
# @return [::Google::Cloud::StorageTransfer::V1::GcsData]
# Cloud Storage intermediate data location.
# @!attribute [rw] object_conditions
# @return [::Google::Cloud::StorageTransfer::V1::ObjectConditions]
# Only objects that satisfy these object conditions are included in the set
# of data source and data sink objects. Object conditions based on
# objects' "last modification time" do not exclude objects in a data sink.
# @!attribute [rw] transfer_options
# @return [::Google::Cloud::StorageTransfer::V1::TransferOptions]
# If the option
# {::Google::Cloud::StorageTransfer::V1::TransferOptions#delete_objects_unique_in_sink delete_objects_unique_in_sink}
# is `true` and time-based object conditions such as 'last modification time'
# are specified, the request fails with an
# {::Google::Rpc::Code::INVALID_ARGUMENT INVALID_ARGUMENT} error.
# @!attribute [rw] transfer_manifest
# @return [::Google::Cloud::StorageTransfer::V1::TransferManifest]
# A manifest file provides a list of objects to be transferred from the data
# source. This field points to the location of the manifest file.
# Otherwise, the entire source bucket is used. ObjectConditions still apply.
# @!attribute [rw] source_agent_pool_name
# @return [::String]
# Specifies the agent pool name associated with the posix data source. When
# unspecified, the default name is used.
# @!attribute [rw] sink_agent_pool_name
# @return [::String]
# Specifies the agent pool name associated with the posix data sink. When
# unspecified, the default name is used.
class TransferSpec
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Specifies the metadata options for running a transfer.
# @!attribute [rw] symlink
# @return [::Google::Cloud::StorageTransfer::V1::MetadataOptions::Symlink]
# Specifies how symlinks should be handled by the transfer. By default,
# symlinks are not preserved. Only applicable to transfers involving
# POSIX file systems, and ignored for other transfers.
# @!attribute [rw] mode
# @return [::Google::Cloud::StorageTransfer::V1::MetadataOptions::Mode]
# Specifies how each file's mode attribute should be handled by the transfer.
# By default, mode is not preserved. Only applicable to transfers involving
# POSIX file systems, and ignored for other transfers.
# @!attribute [rw] gid
# @return [::Google::Cloud::StorageTransfer::V1::MetadataOptions::GID]
# Specifies how each file's POSIX group ID (GID) attribute should be handled
# by the transfer. By default, GID is not preserved. Only applicable to
# transfers involving POSIX file systems, and ignored for other transfers.
# @!attribute [rw] uid
# @return [::Google::Cloud::StorageTransfer::V1::MetadataOptions::UID]
# Specifies how each file's POSIX user ID (UID) attribute should be handled
# by the transfer. By default, UID is not preserved. Only applicable to
# transfers involving POSIX file systems, and ignored for other transfers.
# @!attribute [rw] acl
# @return [::Google::Cloud::StorageTransfer::V1::MetadataOptions::Acl]
# Specifies how each object's ACLs should be preserved for transfers between
# Google Cloud Storage buckets. If unspecified, the default behavior is the
# same as ACL_DESTINATION_BUCKET_DEFAULT.
# @!attribute [rw] storage_class
# @return [::Google::Cloud::StorageTransfer::V1::MetadataOptions::StorageClass]
# Specifies the storage class to set on objects being transferred to Google
# Cloud Storage buckets. If unspecified, the default behavior is the same as
# {::Google::Cloud::StorageTransfer::V1::MetadataOptions::StorageClass::STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT}.
# @!attribute [rw] temporary_hold
# @return [::Google::Cloud::StorageTransfer::V1::MetadataOptions::TemporaryHold]
# Specifies how each object's temporary hold status should be preserved for
# transfers between Google Cloud Storage buckets. If unspecified, the
# default behavior is the same as
# {::Google::Cloud::StorageTransfer::V1::MetadataOptions::TemporaryHold::TEMPORARY_HOLD_PRESERVE TEMPORARY_HOLD_PRESERVE}.
# @!attribute [rw] kms_key
# @return [::Google::Cloud::StorageTransfer::V1::MetadataOptions::KmsKey]
# Specifies how each object's Cloud KMS customer-managed encryption key
# (CMEK) is preserved for transfers between Google Cloud Storage buckets. If
# unspecified, the default behavior is the same as
# {::Google::Cloud::StorageTransfer::V1::MetadataOptions::KmsKey::KMS_KEY_DESTINATION_BUCKET_DEFAULT KMS_KEY_DESTINATION_BUCKET_DEFAULT}.
# @!attribute [rw] time_created
# @return [::Google::Cloud::StorageTransfer::V1::MetadataOptions::TimeCreated]
# Specifies how each object's `timeCreated` metadata is preserved for
# transfers between Google Cloud Storage buckets. If unspecified, the
# default behavior is the same as
# {::Google::Cloud::StorageTransfer::V1::MetadataOptions::TimeCreated::TIME_CREATED_SKIP TIME_CREATED_SKIP}.
class MetadataOptions
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# Whether symlinks should be skipped or preserved during a transfer job.
module Symlink
# Symlink behavior is unspecified.
SYMLINK_UNSPECIFIED = 0
# Do not preserve symlinks during a transfer job.
SYMLINK_SKIP = 1
# Preserve symlinks during a transfer job.
SYMLINK_PRESERVE = 2
end
# Options for handling file mode attribute.
module Mode
# Mode behavior is unspecified.
MODE_UNSPECIFIED = 0
# Do not preserve mode during a transfer job.
MODE_SKIP = 1
# Preserve mode during a transfer job.
MODE_PRESERVE = 2
end
# Options for handling file GID attribute.
module GID
# GID behavior is unspecified.
GID_UNSPECIFIED = 0
# Do not preserve GID during a transfer job.
GID_SKIP = 1
# Preserve GID during a transfer job.
GID_NUMBER = 2
end
# Options for handling file UID attribute.
module UID
# UID behavior is unspecified.
UID_UNSPECIFIED = 0
# Do not preserve UID during a transfer job.
UID_SKIP = 1
# Preserve UID during a transfer job.
UID_NUMBER = 2
end
# Options for handling Cloud Storage object ACLs.
module Acl
# ACL behavior is unspecified.
ACL_UNSPECIFIED = 0
# Use the destination bucket's default object ACLS, if applicable.
ACL_DESTINATION_BUCKET_DEFAULT = 1
# Preserve the object's original ACLs. This requires the service account
# to have `storage.objects.getIamPolicy` permission for the source object.
# [Uniform bucket-level
# access](https://cloud.google.com/storage/docs/uniform-bucket-level-access)
# must not be enabled on either the source or destination buckets.
ACL_PRESERVE = 2
end
# Options for handling Google Cloud Storage object storage class.
module StorageClass
# Storage class behavior is unspecified.
STORAGE_CLASS_UNSPECIFIED = 0
# Use the destination bucket's default storage class.
STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT = 1
# Preserve the object's original storage class. This is only supported for
# transfers from Google Cloud Storage buckets.
STORAGE_CLASS_PRESERVE = 2
# Set the storage class to STANDARD.
STORAGE_CLASS_STANDARD = 3
# Set the storage class to NEARLINE.
STORAGE_CLASS_NEARLINE = 4
# Set the storage class to COLDLINE.
STORAGE_CLASS_COLDLINE = 5
# Set the storage class to ARCHIVE.
STORAGE_CLASS_ARCHIVE = 6
end
# Options for handling temporary holds for Google Cloud Storage objects.
module TemporaryHold
# Temporary hold behavior is unspecified.
TEMPORARY_HOLD_UNSPECIFIED = 0
# Do not set a temporary hold on the destination object.
TEMPORARY_HOLD_SKIP = 1
# Preserve the object's original temporary hold status.
TEMPORARY_HOLD_PRESERVE = 2
end
# Options for handling the KmsKey setting for Google Cloud Storage objects.
module KmsKey
# KmsKey behavior is unspecified.
KMS_KEY_UNSPECIFIED = 0
# Use the destination bucket's default encryption settings.
KMS_KEY_DESTINATION_BUCKET_DEFAULT = 1
# Preserve the object's original Cloud KMS customer-managed encryption key
# (CMEK) if present. Objects that do not use a Cloud KMS encryption key
# will be encrypted using the destination bucket's encryption settings.
KMS_KEY_PRESERVE = 2
end
# Options for handling `timeCreated` metadata for Google Cloud Storage
# objects.
module TimeCreated
# TimeCreated behavior is unspecified.
TIME_CREATED_UNSPECIFIED = 0
# Do not preserve the `timeCreated` metadata from the source object.
TIME_CREATED_SKIP = 1
# Preserves the source object's `timeCreated` metadata in the `customTime`
# field in the destination object. Note that any value stored in the
# source object's `customTime` field will not be propagated to the
# destination object.
TIME_CREATED_PRESERVE_AS_CUSTOM_TIME = 2
end
end
# Specifies where the manifest is located.
# @!attribute [rw] location
# @return [::String]
# Specifies the path to the manifest in Cloud Storage. The Google-managed
# service account for the transfer must have `storage.objects.get`
# permission for this object. An example path is
# `gs://bucket_name/path/manifest.csv`.
class TransferManifest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Transfers can be scheduled to recur or to run just once.
# @!attribute [rw] schedule_start_date
# @return [::Google::Type::Date]
# Required. The start date of a transfer. Date boundaries are determined
# relative to UTC time. If `schedule_start_date` and {::Google::Cloud::StorageTransfer::V1::Schedule#start_time_of_day start_time_of_day}
# are in the past relative to the job's creation time, the transfer starts
# the day after you schedule the transfer request.
#
# **Note:** When starting jobs at or near midnight UTC it is possible that
# a job starts later than expected. For example, if you send an outbound
# request on June 1 one millisecond prior to midnight UTC and the Storage
# Transfer Service server receives the request on June 2, then it creates
# a TransferJob with `schedule_start_date` set to June 2 and a
# `start_time_of_day` set to midnight UTC. The first scheduled
# {::Google::Cloud::StorageTransfer::V1::TransferOperation TransferOperation} takes place on June 3 at midnight UTC.
# @!attribute [rw] schedule_end_date
# @return [::Google::Type::Date]
# The last day a transfer runs. Date boundaries are determined relative to
# UTC time. A job runs once per 24 hours within the following guidelines:
#
# * If `schedule_end_date` and {::Google::Cloud::StorageTransfer::V1::Schedule#schedule_start_date schedule_start_date} are the same and in
# the future relative to UTC, the transfer is executed only one time.
# * If `schedule_end_date` is later than `schedule_start_date` and
# `schedule_end_date` is in the future relative to UTC, the job runs each
# day at {::Google::Cloud::StorageTransfer::V1::Schedule#start_time_of_day start_time_of_day} through `schedule_end_date`.
# @!attribute [rw] start_time_of_day
# @return [::Google::Type::TimeOfDay]
# The time in UTC that a transfer job is scheduled to run. Transfers may
# start later than this time.
#
# If `start_time_of_day` is not specified:
#
# * One-time transfers run immediately.
# * Recurring transfers run immediately, and each day at midnight UTC,
# through {::Google::Cloud::StorageTransfer::V1::Schedule#schedule_end_date schedule_end_date}.
#
# If `start_time_of_day` is specified:
#
# * One-time transfers run at the specified time.
# * Recurring transfers run at the specified time each day, through
# `schedule_end_date`.
# @!attribute [rw] end_time_of_day
# @return [::Google::Type::TimeOfDay]
# The time in UTC that no further transfer operations are scheduled. Combined
# with {::Google::Cloud::StorageTransfer::V1::Schedule#schedule_end_date schedule_end_date}, `end_time_of_day` specifies the end date and
# time for starting new transfer operations. This field must be greater than
# or equal to the timestamp corresponding to the combintation of
# {::Google::Cloud::StorageTransfer::V1::Schedule#schedule_start_date schedule_start_date} and {::Google::Cloud::StorageTransfer::V1::Schedule#start_time_of_day start_time_of_day}, and is subject to the
# following:
#
# * If `end_time_of_day` is not set and `schedule_end_date` is set, then
# a default value of `23:59:59` is used for `end_time_of_day`.
#
# * If `end_time_of_day` is set and `schedule_end_date` is not set, then
# {::Google::Rpc::Code::INVALID_ARGUMENT INVALID_ARGUMENT} is returned.
# @!attribute [rw] repeat_interval
# @return [::Google::Protobuf::Duration]
# Interval between the start of each scheduled TransferOperation. If
# unspecified, the default value is 24 hours. This value may not be less than
# 1 hour.
class Schedule
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# This resource represents the configuration of a transfer job that runs
# periodically.
# @!attribute [rw] name
# @return [::String]
# A unique name (within the transfer project) assigned when the job is
# created. If this field is empty in a CreateTransferJobRequest, Storage
# Transfer Service assigns a unique name. Otherwise, the specified name
# is used as the unique name for this job.
#
# If the specified name is in use by a job, the creation request fails with
# an {::Google::Rpc::Code::ALREADY_EXISTS ALREADY_EXISTS} error.
#
# This name must start with `"transferJobs/"` prefix and end with a letter or
# a number, and should be no more than 128 characters. For transfers
# involving PosixFilesystem, this name must start with `transferJobs/OPI`
# specifically. For all other transfer types, this name must not start with
# `transferJobs/OPI`.
#
# Non-PosixFilesystem example:
# `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"`
#
# PosixFilesystem example:
# `"transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"`
#
# Applications must not rely on the enforcement of naming requirements
# involving OPI.
#
# Invalid job names fail with an
# {::Google::Rpc::Code::INVALID_ARGUMENT INVALID_ARGUMENT} error.
# @!attribute [rw] description
# @return [::String]
# A description provided by the user for the job. Its max length is 1024
# bytes when Unicode-encoded.
# @!attribute [rw] project_id
# @return [::String]
# The ID of the Google Cloud project that owns the job.
# @!attribute [rw] transfer_spec
# @return [::Google::Cloud::StorageTransfer::V1::TransferSpec]
# Transfer specification.
# @!attribute [rw] notification_config
# @return [::Google::Cloud::StorageTransfer::V1::NotificationConfig]
# Notification configuration. This is not supported for transfers involving
# PosixFilesystem.
# @!attribute [rw] logging_config
# @return [::Google::Cloud::StorageTransfer::V1::LoggingConfig]
# Logging configuration.
# @!attribute [rw] schedule
# @return [::Google::Cloud::StorageTransfer::V1::Schedule]
# Specifies schedule for the transfer job.
# This is an optional field. When the field is not set, the job never
# executes a transfer, unless you invoke RunTransferJob or update the job to
# have a non-empty schedule.
# @!attribute [rw] status
# @return [::Google::Cloud::StorageTransfer::V1::TransferJob::Status]
# Status of the job. This value MUST be specified for
# `CreateTransferJobRequests`.
#
# **Note:** The effect of the new job status takes place during a subsequent
# job run. For example, if you change the job status from
# {::Google::Cloud::StorageTransfer::V1::TransferJob::Status::ENABLED ENABLED} to {::Google::Cloud::StorageTransfer::V1::TransferJob::Status::DISABLED DISABLED}, and an operation
# spawned by the transfer is running, the status change would not affect the
# current operation.
# @!attribute [r] creation_time
# @return [::Google::Protobuf::Timestamp]
# Output only. The time that the transfer job was created.
# @!attribute [r] last_modification_time
# @return [::Google::Protobuf::Timestamp]
# Output only. The time that the transfer job was last modified.
# @!attribute [r] deletion_time
# @return [::Google::Protobuf::Timestamp]
# Output only. The time that the transfer job was deleted.
# @!attribute [rw] latest_operation_name
# @return [::String]
# The name of the most recently started TransferOperation of this JobConfig.
# Present if a TransferOperation has been created for this JobConfig.
class TransferJob
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# The status of the transfer job.
module Status
# Zero is an illegal value.
STATUS_UNSPECIFIED = 0
# New transfers are performed based on the schedule.
ENABLED = 1
# New transfers are not scheduled.
DISABLED = 2
# This is a soft delete state. After a transfer job is set to this
# state, the job and all the transfer executions are subject to
# garbage collection. Transfer jobs become eligible for garbage collection
# 30 days after their status is set to `DELETED`.
DELETED = 3
end
end
# An entry describing an error that has occurred.
# @!attribute [rw] url
# @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::StorageTransfer::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
# A collection of counters that report the progress of a transfer operation.
# @!attribute [rw] objects_found_from_source
# @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_from_source
# @return [::Integer]
# 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_found_only_from_sink
# @return [::Integer]
# Objects found only in the data sink that are scheduled to be deleted.
# @!attribute [rw] bytes_found_only_from_sink
# @return [::Integer]
# Bytes found only in the data sink that are scheduled to be deleted.
# @!attribute [rw] objects_from_source_skipped_by_sync
# @return [::Integer]
# Objects in the data source that are not transferred because they already
# exist in the data sink.
# @!attribute [rw] bytes_from_source_skipped_by_sync
# @return [::Integer]
# Bytes in the data source that are not transferred because they already
# exist in the data sink.
# @!attribute [rw] objects_copied_to_sink
# @return [::Integer]
# Objects that are copied to the data sink.
# @!attribute [rw] bytes_copied_to_sink
# @return [::Integer]
# Bytes that are copied to the data sink.
# @!attribute [rw] objects_deleted_from_source
# @return [::Integer]
# Objects that are deleted from the data source.
# @!attribute [rw] bytes_deleted_from_source
# @return [::Integer]
# Bytes that are deleted from the data source.
# @!attribute [rw] objects_deleted_from_sink
# @return [::Integer]
# Objects that are deleted from the data sink.
# @!attribute [rw] bytes_deleted_from_sink
# @return [::Integer]
# Bytes that are deleted from the data sink.
# @!attribute [rw] objects_from_source_failed
# @return [::Integer]
# Objects in the data source that failed to be transferred or that failed
# to be deleted after being transferred.
# @!attribute [rw] bytes_from_source_failed
# @return [::Integer]
# Bytes in the data source that failed to be transferred or that failed to
# be deleted after being transferred.
# @!attribute [rw] objects_failed_to_delete_from_sink
# @return [::Integer]
# Objects that failed to be deleted from the data sink.
# @!attribute [rw] bytes_failed_to_delete_from_sink
# @return [::Integer]
# Bytes that failed to be deleted from the data sink.
# @!attribute [rw] directories_found_from_source
# @return [::Integer]
# For transfers involving PosixFilesystem only.
#
# Number of directories found while listing. For example, if the root
# directory of the transfer is `base/` and there are two other directories,
# `a/` and `b/` under this directory, the count after listing `base/`,
# `base/a/` and `base/b/` is 3.
# @!attribute [rw] directories_failed_to_list_from_source
# @return [::Integer]
# For transfers involving PosixFilesystem only.
#
# Number of listing failures for each directory found at the source.
# Potential failures when listing a directory include permission failure or
# block failure. If listing a directory fails, no files in the directory are
# transferred.
# @!attribute [rw] directories_successfully_listed_from_source
# @return [::Integer]
# For transfers involving PosixFilesystem only.
#
# Number of successful listings for each directory found at the source.
# @!attribute [rw] intermediate_objects_cleaned_up
# @return [::Integer]
# Number of successfully cleaned up intermediate objects.
# @!attribute [rw] intermediate_objects_failed_cleaned_up
# @return [::Integer]
# Number of intermediate objects failed cleaned up.
class TransferCounters
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
# Specification to configure notifications published to Pub/Sub.
# Notifications are published to the customer-provided topic using the
# following `PubsubMessage.attributes`:
#
# * `"eventType"`: one of the {::Google::Cloud::StorageTransfer::V1::NotificationConfig::EventType EventType} values
# * `"payloadFormat"`: one of the {::Google::Cloud::StorageTransfer::V1::NotificationConfig::PayloadFormat PayloadFormat} values
# * `"projectId"`: the {::Google::Cloud::StorageTransfer::V1::TransferOperation#project_id project_id} of the
# `TransferOperation`
# * `"transferJobName"`: the
# {::Google::Cloud::StorageTransfer::V1::TransferOperation#transfer_job_name transfer_job_name} of the
# `TransferOperation`
# * `"transferOperationName"`: the {::Google::Cloud::StorageTransfer::V1::TransferOperation#name name} of the
# `TransferOperation`
#
# The `PubsubMessage.data` contains a {::Google::Cloud::StorageTransfer::V1::TransferOperation TransferOperation} resource
# formatted according to the specified `PayloadFormat`.
# @!attribute [rw] pubsub_topic
# @return [::String]
# Required. The `Topic.name` of the Pub/Sub topic to which to publish
# notifications. Must be of the format: `projects/{project}/topics/{topic}`.
# Not matching this format results in an
# {::Google::Rpc::Code::INVALID_ARGUMENT INVALID_ARGUMENT} error.
# @!attribute [rw] event_types
# @return [::Array<::Google::Cloud::StorageTransfer::V1::NotificationConfig::EventType>]
# Event types for which a notification is desired. If empty, send
# notifications for all event types.
# @!attribute [rw] payload_format
# @return [::Google::Cloud::StorageTransfer::V1::NotificationConfig::PayloadFormat]
# Required. The desired format of the notification message payloads.
class NotificationConfig
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# Enum for specifying event types for which notifications are to be
# published.
#
# Additional event types may be added in the future. Clients should either
# safely ignore unrecognized event types or explicitly specify which event
# types they are prepared to accept.
module EventType
# Illegal value, to avoid allowing a default.
EVENT_TYPE_UNSPECIFIED = 0
# `TransferOperation` completed with status
# {::Google::Cloud::StorageTransfer::V1::TransferOperation::Status::SUCCESS SUCCESS}.
TRANSFER_OPERATION_SUCCESS = 1
# `TransferOperation` completed with status
# {::Google::Cloud::StorageTransfer::V1::TransferOperation::Status::FAILED FAILED}.
TRANSFER_OPERATION_FAILED = 2
# `TransferOperation` completed with status
# {::Google::Cloud::StorageTransfer::V1::TransferOperation::Status::ABORTED ABORTED}.
TRANSFER_OPERATION_ABORTED = 3
end
# Enum for specifying the format of a notification message's payload.
module PayloadFormat
# Illegal value, to avoid allowing a default.
PAYLOAD_FORMAT_UNSPECIFIED = 0
# No payload is included with the notification.
NONE = 1
# `TransferOperation` is [formatted as a JSON
# response](https://developers.google.com/protocol-buffers/docs/proto3#json),
# in application/json.
JSON = 2
end
end
# Specifies the logging behavior for transfer operations.
#
# For cloud-to-cloud transfers, logs are sent to Cloud Logging. See
# [Read transfer
# logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for
# details.
#
# For transfers to or from a POSIX file system, logs are stored in the
# Cloud Storage bucket that is the source or sink of the transfer.
# See [Managing Transfer for on-premises jobs]
# (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs)
# for details.
# @!attribute [rw] log_actions
# @return [::Array<::Google::Cloud::StorageTransfer::V1::LoggingConfig::LoggableAction>]
# Specifies the actions to be logged. If empty, no logs are generated.
# Not supported for transfers with PosixFilesystem data sources; use
# {::Google::Cloud::StorageTransfer::V1::LoggingConfig#enable_onprem_gcs_transfer_logs enable_onprem_gcs_transfer_logs} instead.
# @!attribute [rw] log_action_states
# @return [::Array<::Google::Cloud::StorageTransfer::V1::LoggingConfig::LoggableActionState>]
# States in which `log_actions` are logged. If empty, no logs are generated.
# Not supported for transfers with PosixFilesystem data sources; use
# {::Google::Cloud::StorageTransfer::V1::LoggingConfig#enable_onprem_gcs_transfer_logs enable_onprem_gcs_transfer_logs} instead.
# @!attribute [rw] enable_onprem_gcs_transfer_logs
# @return [::Boolean]
# For transfers with a PosixFilesystem source, this option enables the Cloud
# Storage transfer logs for this transfer.
class LoggingConfig
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# Loggable actions.
module LoggableAction
# Default value. This value is unused.
LOGGABLE_ACTION_UNSPECIFIED = 0
# Listing objects in a bucket.
FIND = 1
# Deleting objects at the source or the destination.
DELETE = 2
# Copying objects to Google Cloud Storage.
COPY = 3
end
# Loggable action states.
module LoggableActionState
# Default value. This value is unused.
LOGGABLE_ACTION_STATE_UNSPECIFIED = 0
# `LoggableAction` completed successfully. `SUCCEEDED` actions are
# logged as [INFO][google.logging.type.LogSeverity.INFO].
SUCCEEDED = 1
# `LoggableAction` terminated in an error state. `FAILED` actions are
# logged as [ERROR][google.logging.type.LogSeverity.ERROR].
FAILED = 2
end
end
# A description of the execution of a transfer.
# @!attribute [rw] name
# @return [::String]
# A globally unique ID assigned by the system.
# @!attribute [rw] project_id
# @return [::String]
# The ID of the Google Cloud project that owns the operation.
# @!attribute [rw] transfer_spec
# @return [::Google::Cloud::StorageTransfer::V1::TransferSpec]
# Transfer specification.
# @!attribute [rw] notification_config
# @return [::Google::Cloud::StorageTransfer::V1::NotificationConfig]
# Notification configuration.
# @!attribute [rw] start_time
# @return [::Google::Protobuf::Timestamp]
# Start time of this transfer execution.
# @!attribute [rw] end_time
# @return [::Google::Protobuf::Timestamp]
# End time of this transfer execution.
# @!attribute [rw] status
# @return [::Google::Cloud::StorageTransfer::V1::TransferOperation::Status]
# Status of the transfer operation.
# @!attribute [rw] counters
# @return [::Google::Cloud::StorageTransfer::V1::TransferCounters]
# Information about the progress of the transfer operation.
# @!attribute [rw] error_breakdowns
# @return [::Array<::Google::Cloud::StorageTransfer::V1::ErrorSummary>]
# Summarizes errors encountered with sample error log entries.
# @!attribute [rw] transfer_job_name
# @return [::String]
# The name of the transfer job that triggers this transfer operation.
class TransferOperation
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
# The status of a TransferOperation.
module Status
# Zero is an illegal value.
STATUS_UNSPECIFIED = 0
# In progress.
IN_PROGRESS = 1
# Paused.
PAUSED = 2
# Completed successfully.
SUCCESS = 3
# Terminated due to an unrecoverable failure.
FAILED = 4
# Aborted by the user.
ABORTED = 5
# Temporarily delayed by the system. No user action is required.
QUEUED = 6
end
end
end
end
end
end