Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.storagetransfer/v1.getTransferJob
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets a transfer job.
Using getTransferJob
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getTransferJob(args: GetTransferJobArgs, opts?: InvokeOptions): Promise<GetTransferJobResult>
function getTransferJobOutput(args: GetTransferJobOutputArgs, opts?: InvokeOptions): Output<GetTransferJobResult>def get_transfer_job(project_id: Optional[str] = None,
                     transfer_job_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetTransferJobResult
def get_transfer_job_output(project_id: Optional[pulumi.Input[str]] = None,
                     transfer_job_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetTransferJobResult]func LookupTransferJob(ctx *Context, args *LookupTransferJobArgs, opts ...InvokeOption) (*LookupTransferJobResult, error)
func LookupTransferJobOutput(ctx *Context, args *LookupTransferJobOutputArgs, opts ...InvokeOption) LookupTransferJobResultOutput> Note: This function is named LookupTransferJob in the Go SDK.
public static class GetTransferJob 
{
    public static Task<GetTransferJobResult> InvokeAsync(GetTransferJobArgs args, InvokeOptions? opts = null)
    public static Output<GetTransferJobResult> Invoke(GetTransferJobInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetTransferJobResult> getTransferJob(GetTransferJobArgs args, InvokeOptions options)
public static Output<GetTransferJobResult> getTransferJob(GetTransferJobArgs args, InvokeOptions options)
fn::invoke:
  function: google-native:storagetransfer/v1:getTransferJob
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ProjectId This property is required. string
- TransferJob Id This property is required. string
- ProjectId This property is required. string
- TransferJob Id This property is required. string
- projectId This property is required. String
- transferJob Id This property is required. String
- projectId This property is required. string
- transferJob Id This property is required. string
- project_id This property is required. str
- transfer_job_ id This property is required. str
- projectId This property is required. String
- transferJob Id This property is required. String
getTransferJob Result
The following output properties are available:
- CreationTime string
- The time that the transfer job was created.
- DeletionTime string
- The time that the transfer job was deleted.
- Description string
- A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
- EventStream Pulumi.Google Native. Storage Transfer. V1. Outputs. Event Stream Response 
- Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
- LastModification stringTime 
- The time that the transfer job was last modified.
- LatestOperation stringName 
- The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
- LoggingConfig Pulumi.Google Native. Storage Transfer. V1. Outputs. Logging Config Response 
- Logging configuration.
- Name 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 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 withtransferJobs/OPIspecifically. For all other transfer types, this name must not start withtransferJobs/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 INVALID_ARGUMENT error.
- NotificationConfig Pulumi.Google Native. Storage Transfer. V1. Outputs. Notification Config Response 
- Notification configuration. This is not supported for transfers involving PosixFilesystem.
- Project string
- The ID of the Google Cloud project that owns the job.
- Schedule
Pulumi.Google Native. Storage Transfer. V1. Outputs. Schedule Response 
- 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.
- Status string
- 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.
- TransferSpec Pulumi.Google Native. Storage Transfer. V1. Outputs. Transfer Spec Response 
- Transfer specification.
- CreationTime string
- The time that the transfer job was created.
- DeletionTime string
- The time that the transfer job was deleted.
- Description string
- A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
- EventStream EventStream Response 
- Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
- LastModification stringTime 
- The time that the transfer job was last modified.
- LatestOperation stringName 
- The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
- LoggingConfig LoggingConfig Response 
- Logging configuration.
- Name 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 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 withtransferJobs/OPIspecifically. For all other transfer types, this name must not start withtransferJobs/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 INVALID_ARGUMENT error.
- NotificationConfig NotificationConfig Response 
- Notification configuration. This is not supported for transfers involving PosixFilesystem.
- Project string
- The ID of the Google Cloud project that owns the job.
- Schedule
ScheduleResponse 
- 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.
- Status string
- 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.
- TransferSpec TransferSpec Response 
- Transfer specification.
- creationTime String
- The time that the transfer job was created.
- deletionTime String
- The time that the transfer job was deleted.
- description String
- A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
- eventStream EventStream Response 
- Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
- lastModification StringTime 
- The time that the transfer job was last modified.
- latestOperation StringName 
- The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
- loggingConfig LoggingConfig Response 
- Logging configuration.
- name 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 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 withtransferJobs/OPIspecifically. For all other transfer types, this name must not start withtransferJobs/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 INVALID_ARGUMENT error.
- notificationConfig NotificationConfig Response 
- Notification configuration. This is not supported for transfers involving PosixFilesystem.
- project String
- The ID of the Google Cloud project that owns the job.
- schedule
ScheduleResponse 
- 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.
- status String
- 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.
- transferSpec TransferSpec Response 
- Transfer specification.
- creationTime string
- The time that the transfer job was created.
- deletionTime string
- The time that the transfer job was deleted.
- description string
- A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
- eventStream EventStream Response 
- Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
- lastModification stringTime 
- The time that the transfer job was last modified.
- latestOperation stringName 
- The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
- loggingConfig LoggingConfig Response 
- Logging configuration.
- name 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 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 withtransferJobs/OPIspecifically. For all other transfer types, this name must not start withtransferJobs/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 INVALID_ARGUMENT error.
- notificationConfig NotificationConfig Response 
- Notification configuration. This is not supported for transfers involving PosixFilesystem.
- project string
- The ID of the Google Cloud project that owns the job.
- schedule
ScheduleResponse 
- 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.
- status string
- 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.
- transferSpec TransferSpec Response 
- Transfer specification.
- creation_time str
- The time that the transfer job was created.
- deletion_time str
- The time that the transfer job was deleted.
- description str
- A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
- event_stream EventStream Response 
- Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
- last_modification_ strtime 
- The time that the transfer job was last modified.
- latest_operation_ strname 
- The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
- logging_config LoggingConfig Response 
- Logging configuration.
- name str
- 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 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 withtransferJobs/OPIspecifically. For all other transfer types, this name must not start withtransferJobs/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 INVALID_ARGUMENT error.
- notification_config NotificationConfig Response 
- Notification configuration. This is not supported for transfers involving PosixFilesystem.
- project str
- The ID of the Google Cloud project that owns the job.
- schedule
ScheduleResponse 
- 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.
- status str
- 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.
- transfer_spec TransferSpec Response 
- Transfer specification.
- creationTime String
- The time that the transfer job was created.
- deletionTime String
- The time that the transfer job was deleted.
- description String
- A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
- eventStream Property Map
- Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
- lastModification StringTime 
- The time that the transfer job was last modified.
- latestOperation StringName 
- The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
- loggingConfig Property Map
- Logging configuration.
- name 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 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 withtransferJobs/OPIspecifically. For all other transfer types, this name must not start withtransferJobs/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 INVALID_ARGUMENT error.
- notificationConfig Property Map
- Notification configuration. This is not supported for transfers involving PosixFilesystem.
- project String
- The ID of the Google Cloud project that owns the job.
- schedule Property Map
- 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.
- status String
- 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.
- transferSpec Property Map
- Transfer specification.
Supporting Types
AwsAccessKeyResponse   
- AccessKey Id This property is required. string
- AWS access key ID.
- SecretAccess Key This property is required. string
- AWS secret access key. This field is not returned in RPC responses.
- AccessKey Id This property is required. string
- AWS access key ID.
- SecretAccess Key This property is required. string
- AWS secret access key. This field is not returned in RPC responses.
- accessKey Id This property is required. String
- AWS access key ID.
- secretAccess Key This property is required. String
- AWS secret access key. This field is not returned in RPC responses.
- accessKey Id This property is required. string
- AWS access key ID.
- secretAccess Key This property is required. string
- AWS secret access key. This field is not returned in RPC responses.
- access_key_ id This property is required. str
- AWS access key ID.
- secret_access_ key This property is required. str
- AWS secret access key. This field is not returned in RPC responses.
- accessKey Id This property is required. String
- AWS access key ID.
- secretAccess Key This property is required. String
- AWS secret access key. This field is not returned in RPC responses.
AwsS3CompatibleDataResponse   
- BucketName This property is required. string
- Specifies the name of the bucket.
- Endpoint
This property is required. string
- Specifies the endpoint of the storage service.
- Path
This property is required. string
- Specifies the 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 '/'.
- Region
This property is required. string
- Specifies the region to sign requests with. This can be left blank if requests should be signed with an empty region.
- S3Metadata
This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. S3Compatible Metadata Response 
- A S3 compatible metadata.
- BucketName This property is required. string
- Specifies the name of the bucket.
- Endpoint
This property is required. string
- Specifies the endpoint of the storage service.
- Path
This property is required. string
- Specifies the 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 '/'.
- Region
This property is required. string
- Specifies the region to sign requests with. This can be left blank if requests should be signed with an empty region.
- S3Metadata
This property is required. S3CompatibleMetadata Response 
- A S3 compatible metadata.
- bucketName This property is required. String
- Specifies the name of the bucket.
- endpoint
This property is required. String
- Specifies the endpoint of the storage service.
- path
This property is required. String
- Specifies the 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 '/'.
- region
This property is required. String
- Specifies the region to sign requests with. This can be left blank if requests should be signed with an empty region.
- s3Metadata
This property is required. S3CompatibleMetadata Response 
- A S3 compatible metadata.
- bucketName This property is required. string
- Specifies the name of the bucket.
- endpoint
This property is required. string
- Specifies the endpoint of the storage service.
- path
This property is required. string
- Specifies the 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 '/'.
- region
This property is required. string
- Specifies the region to sign requests with. This can be left blank if requests should be signed with an empty region.
- s3Metadata
This property is required. S3CompatibleMetadata Response 
- A S3 compatible metadata.
- bucket_name This property is required. str
- Specifies the name of the bucket.
- endpoint
This property is required. str
- Specifies the endpoint of the storage service.
- path
This property is required. str
- Specifies the 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 '/'.
- region
This property is required. str
- Specifies the region to sign requests with. This can be left blank if requests should be signed with an empty region.
- s3_metadata This property is required. S3CompatibleMetadata Response 
- A S3 compatible metadata.
- bucketName This property is required. String
- Specifies the name of the bucket.
- endpoint
This property is required. String
- Specifies the endpoint of the storage service.
- path
This property is required. String
- Specifies the 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 '/'.
- region
This property is required. String
- Specifies the region to sign requests with. This can be left blank if requests should be signed with an empty region.
- s3Metadata
This property is required. Property Map
- A S3 compatible metadata.
AwsS3DataResponse  
- AwsAccess Key This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Aws Access Key Response 
- 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.
- BucketName This property is required. string
- S3 Bucket name (see Creating a bucket).
- CloudfrontDomain This property is required. string
- Optional. Cloudfront domain name pointing to this bucket (as origin), to use when fetching. Format: https://{id}.cloudfront.netor any valid custom domainhttps://...
- CredentialsSecret This property is required. string
- Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessorfor the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. Ifcredentials_secretis specified, do not specify azure_credentials. This feature is in preview. Format:projects/{project_number}/secrets/{secret_name}
- Path
This property is required. 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 '/'.
- RoleArn This property is required. string
- The Amazon Resource Name (ARN) of the role to support temporary credentials via AssumeRoleWithWebIdentity. For more information about ARNs, see IAM ARNs. When a role ARN is provided, Transfer Service fetches temporary credentials for the session using aAssumeRoleWithWebIdentitycall for the provided role using the GoogleServiceAccount for this project.
- AwsAccess Key This property is required. AwsAccess Key Response 
- 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.
- BucketName This property is required. string
- S3 Bucket name (see Creating a bucket).
- CloudfrontDomain This property is required. string
- Optional. Cloudfront domain name pointing to this bucket (as origin), to use when fetching. Format: https://{id}.cloudfront.netor any valid custom domainhttps://...
- CredentialsSecret This property is required. string
- Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessorfor the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. Ifcredentials_secretis specified, do not specify azure_credentials. This feature is in preview. Format:projects/{project_number}/secrets/{secret_name}
- Path
This property is required. 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 '/'.
- RoleArn This property is required. string
- The Amazon Resource Name (ARN) of the role to support temporary credentials via AssumeRoleWithWebIdentity. For more information about ARNs, see IAM ARNs. When a role ARN is provided, Transfer Service fetches temporary credentials for the session using aAssumeRoleWithWebIdentitycall for the provided role using the GoogleServiceAccount for this project.
- awsAccess Key This property is required. AwsAccess Key Response 
- 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.
- bucketName This property is required. String
- S3 Bucket name (see Creating a bucket).
- cloudfrontDomain This property is required. String
- Optional. Cloudfront domain name pointing to this bucket (as origin), to use when fetching. Format: https://{id}.cloudfront.netor any valid custom domainhttps://...
- credentialsSecret This property is required. String
- Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessorfor the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. Ifcredentials_secretis specified, do not specify azure_credentials. This feature is in preview. Format:projects/{project_number}/secrets/{secret_name}
- path
This property is required. 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 '/'.
- roleArn This property is required. String
- The Amazon Resource Name (ARN) of the role to support temporary credentials via AssumeRoleWithWebIdentity. For more information about ARNs, see IAM ARNs. When a role ARN is provided, Transfer Service fetches temporary credentials for the session using aAssumeRoleWithWebIdentitycall for the provided role using the GoogleServiceAccount for this project.
- awsAccess Key This property is required. AwsAccess Key Response 
- 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.
- bucketName This property is required. string
- S3 Bucket name (see Creating a bucket).
- cloudfrontDomain This property is required. string
- Optional. Cloudfront domain name pointing to this bucket (as origin), to use when fetching. Format: https://{id}.cloudfront.netor any valid custom domainhttps://...
- credentialsSecret This property is required. string
- Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessorfor the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. Ifcredentials_secretis specified, do not specify azure_credentials. This feature is in preview. Format:projects/{project_number}/secrets/{secret_name}
- path
This property is required. 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 '/'.
- roleArn This property is required. string
- The Amazon Resource Name (ARN) of the role to support temporary credentials via AssumeRoleWithWebIdentity. For more information about ARNs, see IAM ARNs. When a role ARN is provided, Transfer Service fetches temporary credentials for the session using aAssumeRoleWithWebIdentitycall for the provided role using the GoogleServiceAccount for this project.
- aws_access_ key This property is required. AwsAccess Key Response 
- 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.
- bucket_name This property is required. str
- S3 Bucket name (see Creating a bucket).
- cloudfront_domain This property is required. str
- Optional. Cloudfront domain name pointing to this bucket (as origin), to use when fetching. Format: https://{id}.cloudfront.netor any valid custom domainhttps://...
- credentials_secret This property is required. str
- Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessorfor the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. Ifcredentials_secretis specified, do not specify azure_credentials. This feature is in preview. Format:projects/{project_number}/secrets/{secret_name}
- path
This property is required. str
- 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 '/'.
- role_arn This property is required. str
- The Amazon Resource Name (ARN) of the role to support temporary credentials via AssumeRoleWithWebIdentity. For more information about ARNs, see IAM ARNs. When a role ARN is provided, Transfer Service fetches temporary credentials for the session using aAssumeRoleWithWebIdentitycall for the provided role using the GoogleServiceAccount for this project.
- awsAccess Key This property is required. Property Map
- 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.
- bucketName This property is required. String
- S3 Bucket name (see Creating a bucket).
- cloudfrontDomain This property is required. String
- Optional. Cloudfront domain name pointing to this bucket (as origin), to use when fetching. Format: https://{id}.cloudfront.netor any valid custom domainhttps://...
- credentialsSecret This property is required. String
- Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessorfor the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. Ifcredentials_secretis specified, do not specify azure_credentials. This feature is in preview. Format:projects/{project_number}/secrets/{secret_name}
- path
This property is required. 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 '/'.
- roleArn This property is required. String
- The Amazon Resource Name (ARN) of the role to support temporary credentials via AssumeRoleWithWebIdentity. For more information about ARNs, see IAM ARNs. When a role ARN is provided, Transfer Service fetches temporary credentials for the session using aAssumeRoleWithWebIdentitycall for the provided role using the GoogleServiceAccount for this project.
AzureBlobStorageDataResponse    
- AzureCredentials This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Azure Credentials Response 
- Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see User credentials.
- Container
This property is required. string
- The container to transfer from the Azure Storage account.
- CredentialsSecret This property is required. string
- Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessorfor the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. Ifcredentials_secretis specified, do not specify azure_credentials. This feature is in preview. Format:projects/{project_number}/secrets/{secret_name}
- Path
This property is required. 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 '/'.
- StorageAccount This property is required. string
- The name of the Azure Storage account.
- AzureCredentials This property is required. AzureCredentials Response 
- Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see User credentials.
- Container
This property is required. string
- The container to transfer from the Azure Storage account.
- CredentialsSecret This property is required. string
- Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessorfor the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. Ifcredentials_secretis specified, do not specify azure_credentials. This feature is in preview. Format:projects/{project_number}/secrets/{secret_name}
- Path
This property is required. 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 '/'.
- StorageAccount This property is required. string
- The name of the Azure Storage account.
- azureCredentials This property is required. AzureCredentials Response 
- Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see User credentials.
- container
This property is required. String
- The container to transfer from the Azure Storage account.
- credentialsSecret This property is required. String
- Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessorfor the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. Ifcredentials_secretis specified, do not specify azure_credentials. This feature is in preview. Format:projects/{project_number}/secrets/{secret_name}
- path
This property is required. 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 '/'.
- storageAccount This property is required. String
- The name of the Azure Storage account.
- azureCredentials This property is required. AzureCredentials Response 
- Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see User credentials.
- container
This property is required. string
- The container to transfer from the Azure Storage account.
- credentialsSecret This property is required. string
- Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessorfor the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. Ifcredentials_secretis specified, do not specify azure_credentials. This feature is in preview. Format:projects/{project_number}/secrets/{secret_name}
- path
This property is required. 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 '/'.
- storageAccount This property is required. string
- The name of the Azure Storage account.
- azure_credentials This property is required. AzureCredentials Response 
- Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see User credentials.
- container
This property is required. str
- The container to transfer from the Azure Storage account.
- credentials_secret This property is required. str
- Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessorfor the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. Ifcredentials_secretis specified, do not specify azure_credentials. This feature is in preview. Format:projects/{project_number}/secrets/{secret_name}
- path
This property is required. str
- 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 '/'.
- storage_account This property is required. str
- The name of the Azure Storage account.
- azureCredentials This property is required. Property Map
- Input only. Credentials used to authenticate API requests to Azure. For information on our data retention policy for user credentials, see User credentials.
- container
This property is required. String
- The container to transfer from the Azure Storage account.
- credentialsSecret This property is required. String
- Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessorfor the resource. See [Configure access to a source: Microsoft Azure Blob Storage] (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. Ifcredentials_secretis specified, do not specify azure_credentials. This feature is in preview. Format:projects/{project_number}/secrets/{secret_name}
- path
This property is required. 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 '/'.
- storageAccount This property is required. String
- The name of the Azure Storage account.
AzureCredentialsResponse  
- SasToken This property is required. string
- Azure shared access signature (SAS). For more information about SAS, see Grant limited access to Azure Storage resources using shared access signatures (SAS).
- SasToken This property is required. string
- Azure shared access signature (SAS). For more information about SAS, see Grant limited access to Azure Storage resources using shared access signatures (SAS).
- sasToken This property is required. String
- Azure shared access signature (SAS). For more information about SAS, see Grant limited access to Azure Storage resources using shared access signatures (SAS).
- sasToken This property is required. string
- Azure shared access signature (SAS). For more information about SAS, see Grant limited access to Azure Storage resources using shared access signatures (SAS).
- sas_token This property is required. str
- Azure shared access signature (SAS). For more information about SAS, see Grant limited access to Azure Storage resources using shared access signatures (SAS).
- sasToken This property is required. String
- Azure shared access signature (SAS). For more information about SAS, see Grant limited access to Azure Storage resources using shared access signatures (SAS).
DateResponse 
- Day
This property is required. int
- Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- Month
This property is required. int
- Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- Year
This property is required. int
- Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- Day
This property is required. int
- Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- Month
This property is required. int
- Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- Year
This property is required. int
- Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- day
This property is required. Integer
- Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- month
This property is required. Integer
- Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- year
This property is required. Integer
- Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- day
This property is required. number
- Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- month
This property is required. number
- Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- year
This property is required. number
- Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- day
This property is required. int
- Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- month
This property is required. int
- Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- year
This property is required. int
- Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- day
This property is required. Number
- Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- month
This property is required. Number
- Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- year
This property is required. Number
- Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
EventStreamResponse  
- EventStream Expiration Time This property is required. string
- Specifies the data and time at which Storage Transfer Service stops listening for events from this stream. After this time, any transfers in progress will complete, but no new transfers are initiated.
- EventStream Start Time This property is required. string
- Specifies the date and time that Storage Transfer Service starts listening for events from this stream. If no start time is specified or start time is in the past, Storage Transfer Service starts listening immediately.
- Name
This property is required. string
- Specifies a unique name of the resource such as AWS SQS ARN in the form 'arn:aws:sqs:region:account_id:queue_name', or Pub/Sub subscription resource name in the form 'projects/{project}/subscriptions/{sub}'.
- EventStream Expiration Time This property is required. string
- Specifies the data and time at which Storage Transfer Service stops listening for events from this stream. After this time, any transfers in progress will complete, but no new transfers are initiated.
- EventStream Start Time This property is required. string
- Specifies the date and time that Storage Transfer Service starts listening for events from this stream. If no start time is specified or start time is in the past, Storage Transfer Service starts listening immediately.
- Name
This property is required. string
- Specifies a unique name of the resource such as AWS SQS ARN in the form 'arn:aws:sqs:region:account_id:queue_name', or Pub/Sub subscription resource name in the form 'projects/{project}/subscriptions/{sub}'.
- eventStream Expiration Time This property is required. String
- Specifies the data and time at which Storage Transfer Service stops listening for events from this stream. After this time, any transfers in progress will complete, but no new transfers are initiated.
- eventStream Start Time This property is required. String
- Specifies the date and time that Storage Transfer Service starts listening for events from this stream. If no start time is specified or start time is in the past, Storage Transfer Service starts listening immediately.
- name
This property is required. String
- Specifies a unique name of the resource such as AWS SQS ARN in the form 'arn:aws:sqs:region:account_id:queue_name', or Pub/Sub subscription resource name in the form 'projects/{project}/subscriptions/{sub}'.
- eventStream Expiration Time This property is required. string
- Specifies the data and time at which Storage Transfer Service stops listening for events from this stream. After this time, any transfers in progress will complete, but no new transfers are initiated.
- eventStream Start Time This property is required. string
- Specifies the date and time that Storage Transfer Service starts listening for events from this stream. If no start time is specified or start time is in the past, Storage Transfer Service starts listening immediately.
- name
This property is required. string
- Specifies a unique name of the resource such as AWS SQS ARN in the form 'arn:aws:sqs:region:account_id:queue_name', or Pub/Sub subscription resource name in the form 'projects/{project}/subscriptions/{sub}'.
- event_stream_ expiration_ time This property is required. str
- Specifies the data and time at which Storage Transfer Service stops listening for events from this stream. After this time, any transfers in progress will complete, but no new transfers are initiated.
- event_stream_ start_ time This property is required. str
- Specifies the date and time that Storage Transfer Service starts listening for events from this stream. If no start time is specified or start time is in the past, Storage Transfer Service starts listening immediately.
- name
This property is required. str
- Specifies a unique name of the resource such as AWS SQS ARN in the form 'arn:aws:sqs:region:account_id:queue_name', or Pub/Sub subscription resource name in the form 'projects/{project}/subscriptions/{sub}'.
- eventStream Expiration Time This property is required. String
- Specifies the data and time at which Storage Transfer Service stops listening for events from this stream. After this time, any transfers in progress will complete, but no new transfers are initiated.
- eventStream Start Time This property is required. String
- Specifies the date and time that Storage Transfer Service starts listening for events from this stream. If no start time is specified or start time is in the past, Storage Transfer Service starts listening immediately.
- name
This property is required. String
- Specifies a unique name of the resource such as AWS SQS ARN in the form 'arn:aws:sqs:region:account_id:queue_name', or Pub/Sub subscription resource name in the form 'projects/{project}/subscriptions/{sub}'.
GcsDataResponse  
- BucketName This property is required. string
- Cloud Storage bucket name. Must meet Bucket Name Requirements.
- Path
This property is required. 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.
- BucketName This property is required. string
- Cloud Storage bucket name. Must meet Bucket Name Requirements.
- Path
This property is required. 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.
- bucketName This property is required. String
- Cloud Storage bucket name. Must meet Bucket Name Requirements.
- path
This property is required. 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.
- bucketName This property is required. string
- Cloud Storage bucket name. Must meet Bucket Name Requirements.
- path
This property is required. 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.
- bucket_name This property is required. str
- Cloud Storage bucket name. Must meet Bucket Name Requirements.
- path
This property is required. str
- 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.
- bucketName This property is required. String
- Cloud Storage bucket name. Must meet Bucket Name Requirements.
- path
This property is required. 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.
HttpDataResponse  
- ListUrl This property is required. string
- 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.
- ListUrl This property is required. string
- 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.
- listUrl This property is required. String
- 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.
- listUrl This property is required. string
- 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.
- list_url This property is required. str
- 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.
- listUrl This property is required. String
- 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.
LoggingConfigResponse  
- EnableOnprem Gcs Transfer Logs This property is required. bool
- For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.
- LogAction States This property is required. List<string>
- States in which log_actionsare logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
- LogActions This property is required. List<string>
- Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
- EnableOnprem Gcs Transfer Logs This property is required. bool
- For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.
- LogAction States This property is required. []string
- States in which log_actionsare logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
- LogActions This property is required. []string
- Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
- enableOnprem Gcs Transfer Logs This property is required. Boolean
- For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.
- logAction States This property is required. List<String>
- States in which log_actionsare logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
- logActions This property is required. List<String>
- Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
- enableOnprem Gcs Transfer Logs This property is required. boolean
- For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.
- logAction States This property is required. string[]
- States in which log_actionsare logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
- logActions This property is required. string[]
- Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
- enable_onprem_ gcs_ transfer_ logs This property is required. bool
- For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.
- log_action_ states This property is required. Sequence[str]
- States in which log_actionsare logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
- log_actions This property is required. Sequence[str]
- Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
- enableOnprem Gcs Transfer Logs This property is required. Boolean
- For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.
- logAction States This property is required. List<String>
- States in which log_actionsare logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
- logActions This property is required. List<String>
- Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.
MetadataOptionsResponse  
- Acl
This property is required. string
- 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.
- Gid
This property is required. string
- 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.
- KmsKey This property is required. string
- 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.
- Mode
This property is required. string
- 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.
- StorageClass This property is required. string
- 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.
- Symlink
This property is required. string
- 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.
- TemporaryHold This property is required. string
- 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.
- TimeCreated This property is required. string
- Specifies how each object's timeCreatedmetadata is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as TIME_CREATED_SKIP.
- Uid
This property is required. string
- 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.
- Acl
This property is required. string
- 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.
- Gid
This property is required. string
- 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.
- KmsKey This property is required. string
- 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.
- Mode
This property is required. string
- 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.
- StorageClass This property is required. string
- 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.
- Symlink
This property is required. string
- 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.
- TemporaryHold This property is required. string
- 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.
- TimeCreated This property is required. string
- Specifies how each object's timeCreatedmetadata is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as TIME_CREATED_SKIP.
- Uid
This property is required. string
- 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.
- acl
This property is required. String
- 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.
- gid
This property is required. String
- 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.
- kmsKey This property is required. String
- 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.
- mode
This property is required. String
- 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.
- storageClass This property is required. String
- 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.
- symlink
This property is required. String
- 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.
- temporaryHold This property is required. String
- 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.
- timeCreated This property is required. String
- Specifies how each object's timeCreatedmetadata is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as TIME_CREATED_SKIP.
- uid
This property is required. String
- 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.
- acl
This property is required. string
- 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.
- gid
This property is required. string
- 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.
- kmsKey This property is required. string
- 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.
- mode
This property is required. string
- 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.
- storageClass This property is required. string
- 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.
- symlink
This property is required. string
- 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.
- temporaryHold This property is required. string
- 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.
- timeCreated This property is required. string
- Specifies how each object's timeCreatedmetadata is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as TIME_CREATED_SKIP.
- uid
This property is required. string
- 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.
- acl
This property is required. str
- 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.
- gid
This property is required. str
- 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.
- kms_key This property is required. str
- 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.
- mode
This property is required. str
- 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.
- storage_class This property is required. str
- 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.
- symlink
This property is required. str
- 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.
- temporary_hold This property is required. str
- 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.
- time_created This property is required. str
- Specifies how each object's timeCreatedmetadata is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as TIME_CREATED_SKIP.
- uid
This property is required. str
- 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.
- acl
This property is required. String
- 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.
- gid
This property is required. String
- 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.
- kmsKey This property is required. String
- 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.
- mode
This property is required. String
- 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.
- storageClass This property is required. String
- 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.
- symlink
This property is required. String
- 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.
- temporaryHold This property is required. String
- 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.
- timeCreated This property is required. String
- Specifies how each object's timeCreatedmetadata is preserved for transfers between Google Cloud Storage buckets. If unspecified, the default behavior is the same as TIME_CREATED_SKIP.
- uid
This property is required. String
- 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.
NotificationConfigResponse  
- EventTypes This property is required. List<string>
- Event types for which a notification is desired. If empty, send notifications for all event types.
- PayloadFormat This property is required. string
- The desired format of the notification message payloads.
- PubsubTopic This property is required. string
- The Topic.nameof 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 INVALID_ARGUMENT error.
- EventTypes This property is required. []string
- Event types for which a notification is desired. If empty, send notifications for all event types.
- PayloadFormat This property is required. string
- The desired format of the notification message payloads.
- PubsubTopic This property is required. string
- The Topic.nameof 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 INVALID_ARGUMENT error.
- eventTypes This property is required. List<String>
- Event types for which a notification is desired. If empty, send notifications for all event types.
- payloadFormat This property is required. String
- The desired format of the notification message payloads.
- pubsubTopic This property is required. String
- The Topic.nameof 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 INVALID_ARGUMENT error.
- eventTypes This property is required. string[]
- Event types for which a notification is desired. If empty, send notifications for all event types.
- payloadFormat This property is required. string
- The desired format of the notification message payloads.
- pubsubTopic This property is required. string
- The Topic.nameof 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 INVALID_ARGUMENT error.
- event_types This property is required. Sequence[str]
- Event types for which a notification is desired. If empty, send notifications for all event types.
- payload_format This property is required. str
- The desired format of the notification message payloads.
- pubsub_topic This property is required. str
- The Topic.nameof 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 INVALID_ARGUMENT error.
- eventTypes This property is required. List<String>
- Event types for which a notification is desired. If empty, send notifications for all event types.
- payloadFormat This property is required. String
- The desired format of the notification message payloads.
- pubsubTopic This property is required. String
- The Topic.nameof 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 INVALID_ARGUMENT error.
ObjectConditionsResponse  
- ExcludePrefixes This property is required. List<string>
- If you specify exclude_prefixes, Storage Transfer Service uses the items in theexclude_prefixesarray to determine which objects to exclude from a transfer. Objects must not start with one of the matchingexclude_prefixesfor inclusion in a transfer. The following are requirements ofexclude_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 objects3://my-aws-bucket/logs/y=2015/requests.gz, specify the exclude-prefix aslogs/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 include_prefixes is specified, then each exclude-prefix must start with the value of a path explicitly included byinclude_prefixes. The max size ofexclude_prefixesis 1000. For more information, see Filtering objects from transfers.
- IncludePrefixes This property is required. List<string>
- If you specify include_prefixes, Storage Transfer Service uses the items in theinclude_prefixesarray to determine which objects to include in a transfer. Objects must start with one of the matchinginclude_prefixesfor inclusion in the transfer. If exclude_prefixes is specified, objects must not start with any of theexclude_prefixesspecified for inclusion in the transfer. The following are requirements ofinclude_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 objects3://my-aws-bucket/logs/y=2015/requests.gz, specify the include-prefix aslogs/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 ofinclude_prefixesis 1000. For more information, see Filtering objects from transfers.
- LastModified Before This property is required. string
- If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" are transferred.
- LastModified Since This property is required. string
- 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_sinceandlast_modified_beforefields 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_sinceto the start of the day *last_modified_beforeto the end of the day
- MaxTime Elapsed Since Last Modification This property is required. string
- Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the TransferOperationand 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.
- MinTime Elapsed Since Last Modification This property is required. string
- Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the TransferOperationand 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.
- ExcludePrefixes This property is required. []string
- If you specify exclude_prefixes, Storage Transfer Service uses the items in theexclude_prefixesarray to determine which objects to exclude from a transfer. Objects must not start with one of the matchingexclude_prefixesfor inclusion in a transfer. The following are requirements ofexclude_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 objects3://my-aws-bucket/logs/y=2015/requests.gz, specify the exclude-prefix aslogs/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 include_prefixes is specified, then each exclude-prefix must start with the value of a path explicitly included byinclude_prefixes. The max size ofexclude_prefixesis 1000. For more information, see Filtering objects from transfers.
- IncludePrefixes This property is required. []string
- If you specify include_prefixes, Storage Transfer Service uses the items in theinclude_prefixesarray to determine which objects to include in a transfer. Objects must start with one of the matchinginclude_prefixesfor inclusion in the transfer. If exclude_prefixes is specified, objects must not start with any of theexclude_prefixesspecified for inclusion in the transfer. The following are requirements ofinclude_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 objects3://my-aws-bucket/logs/y=2015/requests.gz, specify the include-prefix aslogs/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 ofinclude_prefixesis 1000. For more information, see Filtering objects from transfers.
- LastModified Before This property is required. string
- If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" are transferred.
- LastModified Since This property is required. string
- 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_sinceandlast_modified_beforefields 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_sinceto the start of the day *last_modified_beforeto the end of the day
- MaxTime Elapsed Since Last Modification This property is required. string
- Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the TransferOperationand 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.
- MinTime Elapsed Since Last Modification This property is required. string
- Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the TransferOperationand 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.
- excludePrefixes This property is required. List<String>
- If you specify exclude_prefixes, Storage Transfer Service uses the items in theexclude_prefixesarray to determine which objects to exclude from a transfer. Objects must not start with one of the matchingexclude_prefixesfor inclusion in a transfer. The following are requirements ofexclude_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 objects3://my-aws-bucket/logs/y=2015/requests.gz, specify the exclude-prefix aslogs/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 include_prefixes is specified, then each exclude-prefix must start with the value of a path explicitly included byinclude_prefixes. The max size ofexclude_prefixesis 1000. For more information, see Filtering objects from transfers.
- includePrefixes This property is required. List<String>
- If you specify include_prefixes, Storage Transfer Service uses the items in theinclude_prefixesarray to determine which objects to include in a transfer. Objects must start with one of the matchinginclude_prefixesfor inclusion in the transfer. If exclude_prefixes is specified, objects must not start with any of theexclude_prefixesspecified for inclusion in the transfer. The following are requirements ofinclude_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 objects3://my-aws-bucket/logs/y=2015/requests.gz, specify the include-prefix aslogs/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 ofinclude_prefixesis 1000. For more information, see Filtering objects from transfers.
- lastModified Before This property is required. String
- If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" are transferred.
- lastModified Since This property is required. String
- 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_sinceandlast_modified_beforefields 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_sinceto the start of the day *last_modified_beforeto the end of the day
- maxTime Elapsed Since Last Modification This property is required. String
- Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the TransferOperationand 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.
- minTime Elapsed Since Last Modification This property is required. String
- Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the TransferOperationand 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.
- excludePrefixes This property is required. string[]
- If you specify exclude_prefixes, Storage Transfer Service uses the items in theexclude_prefixesarray to determine which objects to exclude from a transfer. Objects must not start with one of the matchingexclude_prefixesfor inclusion in a transfer. The following are requirements ofexclude_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 objects3://my-aws-bucket/logs/y=2015/requests.gz, specify the exclude-prefix aslogs/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 include_prefixes is specified, then each exclude-prefix must start with the value of a path explicitly included byinclude_prefixes. The max size ofexclude_prefixesis 1000. For more information, see Filtering objects from transfers.
- includePrefixes This property is required. string[]
- If you specify include_prefixes, Storage Transfer Service uses the items in theinclude_prefixesarray to determine which objects to include in a transfer. Objects must start with one of the matchinginclude_prefixesfor inclusion in the transfer. If exclude_prefixes is specified, objects must not start with any of theexclude_prefixesspecified for inclusion in the transfer. The following are requirements ofinclude_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 objects3://my-aws-bucket/logs/y=2015/requests.gz, specify the include-prefix aslogs/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 ofinclude_prefixesis 1000. For more information, see Filtering objects from transfers.
- lastModified Before This property is required. string
- If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" are transferred.
- lastModified Since This property is required. string
- 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_sinceandlast_modified_beforefields 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_sinceto the start of the day *last_modified_beforeto the end of the day
- maxTime Elapsed Since Last Modification This property is required. string
- Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the TransferOperationand 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.
- minTime Elapsed Since Last Modification This property is required. string
- Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the TransferOperationand 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.
- exclude_prefixes This property is required. Sequence[str]
- If you specify exclude_prefixes, Storage Transfer Service uses the items in theexclude_prefixesarray to determine which objects to exclude from a transfer. Objects must not start with one of the matchingexclude_prefixesfor inclusion in a transfer. The following are requirements ofexclude_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 objects3://my-aws-bucket/logs/y=2015/requests.gz, specify the exclude-prefix aslogs/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 include_prefixes is specified, then each exclude-prefix must start with the value of a path explicitly included byinclude_prefixes. The max size ofexclude_prefixesis 1000. For more information, see Filtering objects from transfers.
- include_prefixes This property is required. Sequence[str]
- If you specify include_prefixes, Storage Transfer Service uses the items in theinclude_prefixesarray to determine which objects to include in a transfer. Objects must start with one of the matchinginclude_prefixesfor inclusion in the transfer. If exclude_prefixes is specified, objects must not start with any of theexclude_prefixesspecified for inclusion in the transfer. The following are requirements ofinclude_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 objects3://my-aws-bucket/logs/y=2015/requests.gz, specify the include-prefix aslogs/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 ofinclude_prefixesis 1000. For more information, see Filtering objects from transfers.
- last_modified_ before This property is required. str
- If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" are transferred.
- last_modified_ since This property is required. str
- 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_sinceandlast_modified_beforefields 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_sinceto the start of the day *last_modified_beforeto the end of the day
- max_time_ elapsed_ since_ last_ modification This property is required. str
- Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the TransferOperationand 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.
- min_time_ elapsed_ since_ last_ modification This property is required. str
- Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the TransferOperationand 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.
- excludePrefixes This property is required. List<String>
- If you specify exclude_prefixes, Storage Transfer Service uses the items in theexclude_prefixesarray to determine which objects to exclude from a transfer. Objects must not start with one of the matchingexclude_prefixesfor inclusion in a transfer. The following are requirements ofexclude_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 objects3://my-aws-bucket/logs/y=2015/requests.gz, specify the exclude-prefix aslogs/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 include_prefixes is specified, then each exclude-prefix must start with the value of a path explicitly included byinclude_prefixes. The max size ofexclude_prefixesis 1000. For more information, see Filtering objects from transfers.
- includePrefixes This property is required. List<String>
- If you specify include_prefixes, Storage Transfer Service uses the items in theinclude_prefixesarray to determine which objects to include in a transfer. Objects must start with one of the matchinginclude_prefixesfor inclusion in the transfer. If exclude_prefixes is specified, objects must not start with any of theexclude_prefixesspecified for inclusion in the transfer. The following are requirements ofinclude_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 objects3://my-aws-bucket/logs/y=2015/requests.gz, specify the include-prefix aslogs/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 ofinclude_prefixesis 1000. For more information, see Filtering objects from transfers.
- lastModified Before This property is required. String
- If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" are transferred.
- lastModified Since This property is required. String
- 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_sinceandlast_modified_beforefields 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_sinceto the start of the day *last_modified_beforeto the end of the day
- maxTime Elapsed Since Last Modification This property is required. String
- Ensures that objects are not transferred if a specific maximum time has elapsed since the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the TransferOperationand 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.
- minTime Elapsed Since Last Modification This property is required. String
- Ensures that objects are not transferred until a specific minimum time has elapsed after the "last modification time". When a TransferOperation begins, objects with a "last modification time" are transferred only if the elapsed time between the start_time of the TransferOperationand 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.
PosixFilesystemResponse  
- RootDirectory This property is required. string
- Root directory path to the filesystem.
- RootDirectory This property is required. string
- Root directory path to the filesystem.
- rootDirectory This property is required. String
- Root directory path to the filesystem.
- rootDirectory This property is required. string
- Root directory path to the filesystem.
- root_directory This property is required. str
- Root directory path to the filesystem.
- rootDirectory This property is required. String
- Root directory path to the filesystem.
S3CompatibleMetadataResponse  
- AuthMethod This property is required. string
- 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.
- ListApi This property is required. string
- The Listing API to use for discovering objects. When not specified, Transfer Service will attempt to determine the right API to use.
- Protocol
This property is required. string
- Specifies the network protocol of the agent. When not specified, the default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
- RequestModel This property is required. string
- 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.
- AuthMethod This property is required. string
- 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.
- ListApi This property is required. string
- The Listing API to use for discovering objects. When not specified, Transfer Service will attempt to determine the right API to use.
- Protocol
This property is required. string
- Specifies the network protocol of the agent. When not specified, the default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
- RequestModel This property is required. string
- 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.
- authMethod This property is required. String
- 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.
- listApi This property is required. String
- The Listing API to use for discovering objects. When not specified, Transfer Service will attempt to determine the right API to use.
- protocol
This property is required. String
- Specifies the network protocol of the agent. When not specified, the default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
- requestModel This property is required. String
- 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.
- authMethod This property is required. string
- 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.
- listApi This property is required. string
- The Listing API to use for discovering objects. When not specified, Transfer Service will attempt to determine the right API to use.
- protocol
This property is required. string
- Specifies the network protocol of the agent. When not specified, the default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
- requestModel This property is required. string
- 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.
- auth_method This property is required. str
- 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.
- list_api This property is required. str
- The Listing API to use for discovering objects. When not specified, Transfer Service will attempt to determine the right API to use.
- protocol
This property is required. str
- Specifies the network protocol of the agent. When not specified, the default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
- request_model This property is required. str
- 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.
- authMethod This property is required. String
- 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.
- listApi This property is required. String
- The Listing API to use for discovering objects. When not specified, Transfer Service will attempt to determine the right API to use.
- protocol
This property is required. String
- Specifies the network protocol of the agent. When not specified, the default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
- requestModel This property is required. String
- 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.
ScheduleResponse 
- EndTime Of Day This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Time Of Day Response 
- The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, end_time_of_dayspecifies 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 schedule_start_date and start_time_of_day, and is subject to the following: * Ifend_time_of_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. * Ifend_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
- RepeatInterval This property is required. string
- 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.
- ScheduleEnd Date This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Date Response 
- 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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. * Ifschedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
- ScheduleStart Date This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Date Response 
- The start date of a transfer. Date boundaries are determined relative to UTC time. If schedule_start_dateand 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 withschedule_start_dateset to June 2 and astart_time_of_dayset to midnight UTC. The first scheduled TransferOperation takes place on June 3 at midnight UTC.
- StartTime Of Day This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Time Of Day Response 
- The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time. If start_time_of_dayis not specified: * One-time transfers run immediately. * Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date. Ifstart_time_of_dayis specified: * One-time transfers run at the specified time. * Recurring transfers run at the specified time each day, throughschedule_end_date.
- EndTime Of Day This property is required. TimeOf Day Response 
- The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, end_time_of_dayspecifies 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 schedule_start_date and start_time_of_day, and is subject to the following: * Ifend_time_of_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. * Ifend_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
- RepeatInterval This property is required. string
- 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.
- ScheduleEnd Date This property is required. DateResponse 
- 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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. * Ifschedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
- ScheduleStart Date This property is required. DateResponse 
- The start date of a transfer. Date boundaries are determined relative to UTC time. If schedule_start_dateand 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 withschedule_start_dateset to June 2 and astart_time_of_dayset to midnight UTC. The first scheduled TransferOperation takes place on June 3 at midnight UTC.
- StartTime Of Day This property is required. TimeOf Day Response 
- The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time. If start_time_of_dayis not specified: * One-time transfers run immediately. * Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date. Ifstart_time_of_dayis specified: * One-time transfers run at the specified time. * Recurring transfers run at the specified time each day, throughschedule_end_date.
- endTime Of Day This property is required. TimeOf Day Response 
- The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, end_time_of_dayspecifies 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 schedule_start_date and start_time_of_day, and is subject to the following: * Ifend_time_of_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. * Ifend_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
- repeatInterval This property is required. String
- 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.
- scheduleEnd Date This property is required. DateResponse 
- 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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. * Ifschedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
- scheduleStart Date This property is required. DateResponse 
- The start date of a transfer. Date boundaries are determined relative to UTC time. If schedule_start_dateand 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 withschedule_start_dateset to June 2 and astart_time_of_dayset to midnight UTC. The first scheduled TransferOperation takes place on June 3 at midnight UTC.
- startTime Of Day This property is required. TimeOf Day Response 
- The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time. If start_time_of_dayis not specified: * One-time transfers run immediately. * Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date. Ifstart_time_of_dayis specified: * One-time transfers run at the specified time. * Recurring transfers run at the specified time each day, throughschedule_end_date.
- endTime Of Day This property is required. TimeOf Day Response 
- The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, end_time_of_dayspecifies 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 schedule_start_date and start_time_of_day, and is subject to the following: * Ifend_time_of_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. * Ifend_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
- repeatInterval This property is required. string
- 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.
- scheduleEnd Date This property is required. DateResponse 
- 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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. * Ifschedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
- scheduleStart Date This property is required. DateResponse 
- The start date of a transfer. Date boundaries are determined relative to UTC time. If schedule_start_dateand 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 withschedule_start_dateset to June 2 and astart_time_of_dayset to midnight UTC. The first scheduled TransferOperation takes place on June 3 at midnight UTC.
- startTime Of Day This property is required. TimeOf Day Response 
- The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time. If start_time_of_dayis not specified: * One-time transfers run immediately. * Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date. Ifstart_time_of_dayis specified: * One-time transfers run at the specified time. * Recurring transfers run at the specified time each day, throughschedule_end_date.
- end_time_ of_ day This property is required. TimeOf Day Response 
- The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, end_time_of_dayspecifies 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 schedule_start_date and start_time_of_day, and is subject to the following: * Ifend_time_of_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. * Ifend_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
- repeat_interval This property is required. str
- 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.
- schedule_end_ date This property is required. DateResponse 
- 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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. * Ifschedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
- schedule_start_ date This property is required. DateResponse 
- The start date of a transfer. Date boundaries are determined relative to UTC time. If schedule_start_dateand 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 withschedule_start_dateset to June 2 and astart_time_of_dayset to midnight UTC. The first scheduled TransferOperation takes place on June 3 at midnight UTC.
- start_time_ of_ day This property is required. TimeOf Day Response 
- The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time. If start_time_of_dayis not specified: * One-time transfers run immediately. * Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date. Ifstart_time_of_dayis specified: * One-time transfers run at the specified time. * Recurring transfers run at the specified time each day, throughschedule_end_date.
- endTime Of Day This property is required. Property Map
- The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, end_time_of_dayspecifies 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 schedule_start_date and start_time_of_day, and is subject to the following: * Ifend_time_of_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. * Ifend_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
- repeatInterval This property is required. String
- 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.
- scheduleEnd Date This property is required. Property Map
- 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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. * Ifschedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
- scheduleStart Date This property is required. Property Map
- The start date of a transfer. Date boundaries are determined relative to UTC time. If schedule_start_dateand 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 withschedule_start_dateset to June 2 and astart_time_of_dayset to midnight UTC. The first scheduled TransferOperation takes place on June 3 at midnight UTC.
- startTime Of Day This property is required. Property Map
- The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time. If start_time_of_dayis not specified: * One-time transfers run immediately. * Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date. Ifstart_time_of_dayis specified: * One-time transfers run at the specified time. * Recurring transfers run at the specified time each day, throughschedule_end_date.
TimeOfDayResponse   
- Hours
This property is required. int
- Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- Minutes
This property is required. int
- Minutes of hour of day. Must be from 0 to 59.
- Nanos
This property is required. int
- Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- Seconds
This property is required. int
- Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- Hours
This property is required. int
- Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- Minutes
This property is required. int
- Minutes of hour of day. Must be from 0 to 59.
- Nanos
This property is required. int
- Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- Seconds
This property is required. int
- Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- hours
This property is required. Integer
- Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- minutes
This property is required. Integer
- Minutes of hour of day. Must be from 0 to 59.
- nanos
This property is required. Integer
- Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- seconds
This property is required. Integer
- Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- hours
This property is required. number
- Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- minutes
This property is required. number
- Minutes of hour of day. Must be from 0 to 59.
- nanos
This property is required. number
- Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- seconds
This property is required. number
- Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- hours
This property is required. int
- Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- minutes
This property is required. int
- Minutes of hour of day. Must be from 0 to 59.
- nanos
This property is required. int
- Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- seconds
This property is required. int
- Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- hours
This property is required. Number
- Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- minutes
This property is required. Number
- Minutes of hour of day. Must be from 0 to 59.
- nanos
This property is required. Number
- Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
- seconds
This property is required. Number
- Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
TransferManifestResponse  
- Location
This property is required. string
- Specifies the path to the manifest in Cloud Storage. The Google-managed service account for the transfer must have storage.objects.getpermission for this object. An example path isgs://bucket_name/path/manifest.csv.
- Location
This property is required. string
- Specifies the path to the manifest in Cloud Storage. The Google-managed service account for the transfer must have storage.objects.getpermission for this object. An example path isgs://bucket_name/path/manifest.csv.
- location
This property is required. String
- Specifies the path to the manifest in Cloud Storage. The Google-managed service account for the transfer must have storage.objects.getpermission for this object. An example path isgs://bucket_name/path/manifest.csv.
- location
This property is required. string
- Specifies the path to the manifest in Cloud Storage. The Google-managed service account for the transfer must have storage.objects.getpermission for this object. An example path isgs://bucket_name/path/manifest.csv.
- location
This property is required. str
- Specifies the path to the manifest in Cloud Storage. The Google-managed service account for the transfer must have storage.objects.getpermission for this object. An example path isgs://bucket_name/path/manifest.csv.
- location
This property is required. String
- Specifies the path to the manifest in Cloud Storage. The Google-managed service account for the transfer must have storage.objects.getpermission for this object. An example path isgs://bucket_name/path/manifest.csv.
TransferOptionsResponse  
- DeleteObjects From Source After Transfer This property is required. bool
- Whether objects should be deleted from the source after they are transferred to the sink. Note: This option and delete_objects_unique_in_sink are mutually exclusive.
- DeleteObjects Unique In Sink This property is required. bool
- Whether objects that exist only in the sink should be deleted. Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.
- MetadataOptions This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Metadata Options Response 
- Represents the selected metadata options for a transfer job.
- OverwriteObjects Already Existing In Sink This property is required. bool
- 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.
- OverwriteWhen This property is required. string
- When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.
- DeleteObjects From Source After Transfer This property is required. bool
- Whether objects should be deleted from the source after they are transferred to the sink. Note: This option and delete_objects_unique_in_sink are mutually exclusive.
- DeleteObjects Unique In Sink This property is required. bool
- Whether objects that exist only in the sink should be deleted. Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.
- MetadataOptions This property is required. MetadataOptions Response 
- Represents the selected metadata options for a transfer job.
- OverwriteObjects Already Existing In Sink This property is required. bool
- 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.
- OverwriteWhen This property is required. string
- When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.
- deleteObjects From Source After Transfer This property is required. Boolean
- Whether objects should be deleted from the source after they are transferred to the sink. Note: This option and delete_objects_unique_in_sink are mutually exclusive.
- deleteObjects Unique In Sink This property is required. Boolean
- Whether objects that exist only in the sink should be deleted. Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.
- metadataOptions This property is required. MetadataOptions Response 
- Represents the selected metadata options for a transfer job.
- overwriteObjects Already Existing In Sink This property is required. 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.
- overwriteWhen This property is required. String
- When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.
- deleteObjects From Source After Transfer This property is required. boolean
- Whether objects should be deleted from the source after they are transferred to the sink. Note: This option and delete_objects_unique_in_sink are mutually exclusive.
- deleteObjects Unique In Sink This property is required. boolean
- Whether objects that exist only in the sink should be deleted. Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.
- metadataOptions This property is required. MetadataOptions Response 
- Represents the selected metadata options for a transfer job.
- overwriteObjects Already Existing In Sink This property is required. 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.
- overwriteWhen This property is required. string
- When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.
- delete_objects_ from_ source_ after_ transfer This property is required. bool
- Whether objects should be deleted from the source after they are transferred to the sink. Note: This option and delete_objects_unique_in_sink are mutually exclusive.
- delete_objects_ unique_ in_ sink This property is required. bool
- Whether objects that exist only in the sink should be deleted. Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.
- metadata_options This property is required. MetadataOptions Response 
- Represents the selected metadata options for a transfer job.
- overwrite_objects_ already_ existing_ in_ sink This property is required. bool
- 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.
- overwrite_when This property is required. str
- When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.
- deleteObjects From Source After Transfer This property is required. Boolean
- Whether objects should be deleted from the source after they are transferred to the sink. Note: This option and delete_objects_unique_in_sink are mutually exclusive.
- deleteObjects Unique In Sink This property is required. Boolean
- Whether objects that exist only in the sink should be deleted. Note: This option and delete_objects_from_source_after_transfer are mutually exclusive.
- metadataOptions This property is required. Property Map
- Represents the selected metadata options for a transfer job.
- overwriteObjects Already Existing In Sink This property is required. 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.
- overwriteWhen This property is required. String
- When to overwrite objects that already exist in the sink. If not set, overwrite behavior is determined by overwrite_objects_already_existing_in_sink.
TransferSpecResponse  
- AwsS3Compatible Data Source This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Aws S3Compatible Data Response 
- An AWS S3 compatible data source.
- AwsS3Data Source This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Aws S3Data Response 
- An AWS S3 data source.
- AzureBlob Storage Data Source This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Azure Blob Storage Data Response 
- An Azure Blob Storage data source.
- GcsData Sink This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Gcs Data Response 
- A Cloud Storage data sink.
- GcsData Source This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Gcs Data Response 
- A Cloud Storage data source.
- GcsIntermediate Data Location This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Gcs Data Response 
- For transfers between file systems, specifies a Cloud Storage bucket to be used as an intermediate location through which to transfer data. See Transfer data between file systems for more information.
- HttpData Source This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Http Data Response 
- An HTTP URL data source.
- ObjectConditions This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Object Conditions Response 
- 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.
- PosixData Sink This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Posix Filesystem Response 
- A POSIX Filesystem data sink.
- PosixData Source This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Posix Filesystem Response 
- A POSIX Filesystem data source.
- SinkAgent Pool Name This property is required. string
- Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
- SourceAgent Pool Name This property is required. string
- Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
- TransferManifest This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Transfer Manifest Response 
- 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.
- TransferOptions This property is required. Pulumi.Google Native. Storage Transfer. V1. Inputs. Transfer Options Response 
- If the option delete_objects_unique_in_sink is trueand time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error.
- AwsS3Compatible Data Source This property is required. AwsS3Compatible Data Response 
- An AWS S3 compatible data source.
- AwsS3Data Source This property is required. AwsS3Data Response 
- An AWS S3 data source.
- AzureBlob Storage Data Source This property is required. AzureBlob Storage Data Response 
- An Azure Blob Storage data source.
- GcsData Sink This property is required. GcsData Response 
- A Cloud Storage data sink.
- GcsData Source This property is required. GcsData Response 
- A Cloud Storage data source.
- GcsIntermediate Data Location This property is required. GcsData Response 
- For transfers between file systems, specifies a Cloud Storage bucket to be used as an intermediate location through which to transfer data. See Transfer data between file systems for more information.
- HttpData Source This property is required. HttpData Response 
- An HTTP URL data source.
- ObjectConditions This property is required. ObjectConditions Response 
- 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.
- PosixData Sink This property is required. PosixFilesystem Response 
- A POSIX Filesystem data sink.
- PosixData Source This property is required. PosixFilesystem Response 
- A POSIX Filesystem data source.
- SinkAgent Pool Name This property is required. string
- Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
- SourceAgent Pool Name This property is required. string
- Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
- TransferManifest This property is required. TransferManifest Response 
- 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.
- TransferOptions This property is required. TransferOptions Response 
- If the option delete_objects_unique_in_sink is trueand time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error.
- awsS3Compatible Data Source This property is required. AwsS3Compatible Data Response 
- An AWS S3 compatible data source.
- awsS3Data Source This property is required. AwsS3Data Response 
- An AWS S3 data source.
- azureBlob Storage Data Source This property is required. AzureBlob Storage Data Response 
- An Azure Blob Storage data source.
- gcsData Sink This property is required. GcsData Response 
- A Cloud Storage data sink.
- gcsData Source This property is required. GcsData Response 
- A Cloud Storage data source.
- gcsIntermediate Data Location This property is required. GcsData Response 
- For transfers between file systems, specifies a Cloud Storage bucket to be used as an intermediate location through which to transfer data. See Transfer data between file systems for more information.
- httpData Source This property is required. HttpData Response 
- An HTTP URL data source.
- objectConditions This property is required. ObjectConditions Response 
- 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.
- posixData Sink This property is required. PosixFilesystem Response 
- A POSIX Filesystem data sink.
- posixData Source This property is required. PosixFilesystem Response 
- A POSIX Filesystem data source.
- sinkAgent Pool Name This property is required. String
- Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
- sourceAgent Pool Name This property is required. String
- Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
- transferManifest This property is required. TransferManifest Response 
- 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.
- transferOptions This property is required. TransferOptions Response 
- If the option delete_objects_unique_in_sink is trueand time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error.
- awsS3Compatible Data Source This property is required. AwsS3Compatible Data Response 
- An AWS S3 compatible data source.
- awsS3Data Source This property is required. AwsS3Data Response 
- An AWS S3 data source.
- azureBlob Storage Data Source This property is required. AzureBlob Storage Data Response 
- An Azure Blob Storage data source.
- gcsData Sink This property is required. GcsData Response 
- A Cloud Storage data sink.
- gcsData Source This property is required. GcsData Response 
- A Cloud Storage data source.
- gcsIntermediate Data Location This property is required. GcsData Response 
- For transfers between file systems, specifies a Cloud Storage bucket to be used as an intermediate location through which to transfer data. See Transfer data between file systems for more information.
- httpData Source This property is required. HttpData Response 
- An HTTP URL data source.
- objectConditions This property is required. ObjectConditions Response 
- 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.
- posixData Sink This property is required. PosixFilesystem Response 
- A POSIX Filesystem data sink.
- posixData Source This property is required. PosixFilesystem Response 
- A POSIX Filesystem data source.
- sinkAgent Pool Name This property is required. string
- Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
- sourceAgent Pool Name This property is required. string
- Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
- transferManifest This property is required. TransferManifest Response 
- 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.
- transferOptions This property is required. TransferOptions Response 
- If the option delete_objects_unique_in_sink is trueand time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error.
- aws_s3_ compatible_ data_ source This property is required. AwsS3Compatible Data Response 
- An AWS S3 compatible data source.
- aws_s3_ data_ source This property is required. AwsS3Data Response 
- An AWS S3 data source.
- azure_blob_ storage_ data_ source This property is required. AzureBlob Storage Data Response 
- An Azure Blob Storage data source.
- gcs_data_ sink This property is required. GcsData Response 
- A Cloud Storage data sink.
- gcs_data_ source This property is required. GcsData Response 
- A Cloud Storage data source.
- gcs_intermediate_ data_ location This property is required. GcsData Response 
- For transfers between file systems, specifies a Cloud Storage bucket to be used as an intermediate location through which to transfer data. See Transfer data between file systems for more information.
- http_data_ source This property is required. HttpData Response 
- An HTTP URL data source.
- object_conditions This property is required. ObjectConditions Response 
- 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.
- posix_data_ sink This property is required. PosixFilesystem Response 
- A POSIX Filesystem data sink.
- posix_data_ source This property is required. PosixFilesystem Response 
- A POSIX Filesystem data source.
- sink_agent_ pool_ name This property is required. str
- Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
- source_agent_ pool_ name This property is required. str
- Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
- transfer_manifest This property is required. TransferManifest Response 
- 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.
- transfer_options This property is required. TransferOptions Response 
- If the option delete_objects_unique_in_sink is trueand time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error.
- awsS3Compatible Data Source This property is required. Property Map
- An AWS S3 compatible data source.
- awsS3Data Source This property is required. Property Map
- An AWS S3 data source.
- azureBlob Storage Data Source This property is required. Property Map
- An Azure Blob Storage data source.
- gcsData Sink This property is required. Property Map
- A Cloud Storage data sink.
- gcsData Source This property is required. Property Map
- A Cloud Storage data source.
- gcsIntermediate Data Location This property is required. Property Map
- For transfers between file systems, specifies a Cloud Storage bucket to be used as an intermediate location through which to transfer data. See Transfer data between file systems for more information.
- httpData Source This property is required. Property Map
- An HTTP URL data source.
- objectConditions This property is required. Property Map
- 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.
- posixData Sink This property is required. Property Map
- A POSIX Filesystem data sink.
- posixData Source This property is required. Property Map
- A POSIX Filesystem data source.
- sinkAgent Pool Name This property is required. String
- Specifies the agent pool name associated with the posix data sink. When unspecified, the default name is used.
- sourceAgent Pool Name This property is required. String
- Specifies the agent pool name associated with the posix data source. When unspecified, the default name is used.
- transferManifest This property is required. Property Map
- 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.
- transferOptions This property is required. Property Map
- If the option delete_objects_unique_in_sink is trueand time-based object conditions such as 'last modification time' are specified, the request fails with an INVALID_ARGUMENT error.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi