storagetransfer library

Classes

AgentPool
Creates an agent pool resource.
AgentPoolArgs
The set of arguments for AgentPool. The set of arguments for AgentPool.
AwsAccessKey
AWS access key (see AWS Security Credentials). For information on our data retention policy for user credentials, see User credentials.
AwsAccessKeyResponse
AWS access key (see AWS Security Credentials). For information on our data retention policy for user credentials, see User credentials.
AwsS3CompatibleData
An AwsS3CompatibleData resource.
AwsS3CompatibleDataResponse
An AwsS3CompatibleData resource.
AwsS3Data
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.
AwsS3DataResponse
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.
AzureBlobStorageData
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. In an AzureBlobStorageData resource, a blobs's name is the Azure Blob Storage blob's key name.
AzureBlobStorageDataResponse
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. In an AzureBlobStorageData resource, a blobs's name is the Azure Blob Storage blob's key name.
AzureCredentials
Azure credentials For information on our data retention policy for user credentials, see User credentials.
AzureCredentialsResponse
Azure credentials For information on our data retention policy for user credentials, see User credentials.
BandwidthLimit
Specifies a bandwidth limit for an agent pool.
BandwidthLimitResponse
Specifies a bandwidth limit for an agent pool.
Date
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
DateResponse
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
EventStream
Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.
EventStreamResponse
Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.
GcsData
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.
GcsDataResponse
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.
GetAgentPoolArgs
Arguments for getAgentPool. Arguments for getAgentPool.
GetAgentPoolResult
Result data returned by getAgentPool.
GetTransferJobArgs
Arguments for getTransferJob. Arguments for getTransferJob.
GetTransferJobResult
Result data returned by getTransferJob.
HttpData
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. When transferring data based on a URL list, keep the following in mind: * When an object located at http(s)://hostname:port/ is transferred to a data sink, the name of the object at the data sink is /. * 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. * ObjectConditions have no effect when filtering objects to transfer.
HttpDataResponse
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. When transferring data based on a URL list, keep the following in mind: * When an object located at http(s)://hostname:port/ is transferred to a data sink, the name of the object at the data sink is /. * 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. * ObjectConditions have no effect when filtering objects to transfer.
LoggingConfig
Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See 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.
LoggingConfigResponse
Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See 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.
MetadataOptions
Specifies the metadata options for running a transfer.
MetadataOptionsResponse
Specifies the metadata options for running a transfer.
NotificationConfig
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 EventType values * "payloadFormat": one of the PayloadFormat values * "projectId": the project_id of the TransferOperation * "transferJobName": the transfer_job_name of the TransferOperation * "transferOperationName": the name of the TransferOperation The PubsubMessage.data contains a TransferOperation resource formatted according to the specified PayloadFormat.
NotificationConfigResponse
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 EventType values * "payloadFormat": one of the PayloadFormat values * "projectId": the project_id of the TransferOperation * "transferJobName": the transfer_job_name of the TransferOperation * "transferOperationName": the name of the TransferOperation The PubsubMessage.data contains a TransferOperation resource formatted according to the specified PayloadFormat.
ObjectConditions
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 PosixFilesystem source or destination don't support ObjectConditions.
ObjectConditionsResponse
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 PosixFilesystem source or destination don't support ObjectConditions.
PosixFilesystem
A POSIX filesystem resource.
PosixFilesystemResponse
A POSIX filesystem resource.
S3CompatibleMetadata
S3CompatibleMetadata contains the metadata fields that apply to the basic types of S3-compatible data providers.
S3CompatibleMetadataResponse
S3CompatibleMetadata contains the metadata fields that apply to the basic types of S3-compatible data providers.
Schedule
Transfers can be scheduled to recur or to run just once.
ScheduleResponse
Transfers can be scheduled to recur or to run just once.
TimeOfDay
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
TimeOfDayResponse
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
TransferJob
Creates a transfer job that runs periodically.
TransferJobArgs
The set of arguments for TransferJob. The set of arguments for TransferJob.
TransferManifest
Specifies where the manifest is located.
TransferManifestResponse
Specifies where the manifest is located.
TransferOptions
TransferOptions define the actions to be performed on objects in a transfer.
TransferOptionsResponse
TransferOptions define the actions to be performed on objects in a transfer.
TransferSpec
Configuration for running a transfer.
TransferSpecResponse
Configuration for running a transfer.

Enums

LoggingConfigLogActionsItem
LoggingConfigLogActionStatesItem
MetadataOptionsAcl
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.
MetadataOptionsGid
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.
MetadataOptionsKmsKey
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 KMS_KEY_DESTINATION_BUCKET_DEFAULT.
MetadataOptionsMode
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.
MetadataOptionsStorageClass
Specifies the storage class to set on objects being transferred to Google Cloud Storage buckets. If unspecified, the default behavior is the same as STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT.
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.
MetadataOptionsTemporaryHold
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 TEMPORARY_HOLD_PRESERVE.
MetadataOptionsTimeCreated
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 TIME_CREATED_SKIP.
MetadataOptionsUid
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.
NotificationConfigEventTypesItem
NotificationConfigPayloadFormat
Required. The desired format of the notification message payloads.
S3CompatibleMetadataAuthMethod
Specifies the authentication and authorization method used by the storage service. When not specified, Transfer Service will attempt to determine right auth method to use.
S3CompatibleMetadataListApi
The Listing API to use for discovering objects. When not specified, Transfer Service will attempt to determine the right API to use.
S3CompatibleMetadataProtocol
Specifies the network protocol of the agent. When not specified, the default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
S3CompatibleMetadataRequestModel
Specifies the API request model used to call the storage service. When not specified, the default value of RequestModel REQUEST_MODEL_VIRTUAL_HOSTED_STYLE is used.
TransferJobStatus
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 ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.
TransferOptionsOverwriteWhen
When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.

Functions

getAgentPool(GetAgentPoolArgs args, {InvokeOptions? options}) → Future<GetAgentPoolResult>
Gets an agent pool. args Arguments passed to this invoke. Arguments for getAgentPool. options Invoke options controlling this call.
getTransferJob(GetTransferJobArgs args, {InvokeOptions? options}) → Future<GetTransferJobResult>
Gets a transfer job. args Arguments passed to this invoke. Arguments for getTransferJob. options Invoke options controlling this call.