Class: Google::Cloud::StorageTransfer::V1::TransferJob

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/storagetransfer/v1/transfer_types.rb

Overview

This resource represents the configuration of a transfer job that runs periodically.

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time that the transfer job was created.

Returns:



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#deletion_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time that the transfer job was deleted.

Returns:



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#description ⇒ ::String

Returns A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.

Returns:

  • (::String) —

    A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#event_stream ⇒ ::Google::Cloud::StorageTransfer::V1::EventStream

Returns Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.

Returns:



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#last_modification_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time that the transfer job was last modified.

Returns:



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#latest_operation_name ⇒ ::String

Returns The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.

Returns:

  • (::String) —

    The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#logging_config ⇒ ::Google::Cloud::StorageTransfer::V1::LoggingConfig

Returns Logging configuration.

Returns:



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#name ⇒ ::String

Returns 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 with transferJobs/OPI specifically. For all other transfer types, this name must not start with transferJobs/OPI.

Non-PosixFilesystem example: "transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"

PosixFilesystem example: "transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"

Applications must not rely on the enforcement of naming requirements involving OPI.

Invalid job names fail with an INVALID_ARGUMENT error.

Returns:

  • (::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 with transferJobs/OPI specifically. For all other transfer types, this name must not start with transferJobs/OPI.

    Non-PosixFilesystem example: "transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"

    PosixFilesystem example: "transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"

    Applications must not rely on the enforcement of naming requirements involving OPI.

    Invalid job names fail with an INVALID_ARGUMENT error.



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#notification_config ⇒ ::Google::Cloud::StorageTransfer::V1::NotificationConfig

Returns Notification configuration.

Returns:



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#project_id ⇒ ::String

Returns The ID of the Google Cloud project that owns the job.

Returns:

  • (::String) —

    The ID of the Google Cloud project that owns the job.



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#replication_spec ⇒ ::Google::Cloud::StorageTransfer::V1::ReplicationSpec

Returns Replication specification.

Returns:



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#schedule ⇒ ::Google::Cloud::StorageTransfer::V1::Schedule

Returns 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.

Returns:

  • (::Google::Cloud::StorageTransfer::V1::Schedule) —

    Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#service_account ⇒ ::String

Returns Optional. The user-managed service account to which to delegate service agent permissions. You can grant Cloud Storage bucket permissions to this service account instead of to the Transfer Service service agent.

Format is projects/-/serviceAccounts/ACCOUNT_EMAIL_OR_UNIQUEID

Either the service account email (SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com) or the unique ID (123456789012345678901) are accepted in the string. The - wildcard character is required; replacing it with a project ID is invalid.

See https://cloud.google.com//storage-transfer/docs/delegate-service-agent-permissions for required permissions.

Returns:

  • (::String) —

    Optional. The user-managed service account to which to delegate service agent permissions. You can grant Cloud Storage bucket permissions to this service account instead of to the Transfer Service service agent.

    Format is projects/-/serviceAccounts/ACCOUNT_EMAIL_OR_UNIQUEID

    Either the service account email (SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com) or the unique ID (123456789012345678901) are accepted in the string. The - wildcard character is required; replacing it with a project ID is invalid.

    See https://cloud.google.com//storage-transfer/docs/delegate-service-agent-permissions for required permissions.



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#status ⇒ ::Google::Cloud::StorageTransfer::V1::TransferJob::Status

Returns 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.

Returns:

  • (::Google::Cloud::StorageTransfer::V1::TransferJob::Status) —

    Status of the job. This value MUST be specified for CreateTransferJobRequests.

    Note: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end

#transfer_spec ⇒ ::Google::Cloud::StorageTransfer::V1::TransferSpec

Returns Transfer specification.

Returns:



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1185

class TransferJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of the transfer job.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # New transfers are performed based on the schedule.
    ENABLED = 1

    # New transfers are not scheduled.
    DISABLED = 2

    # This is a soft delete state. After a transfer job is set to this
    # state, the job and all the transfer executions are subject to
    # garbage collection. Transfer jobs become eligible for garbage collection
    # 30 days after their status is set to `DELETED`.
    DELETED = 3
  end
end