Storage Transfer Service V1 API - Class Google::Cloud::StorageTransfer::V1::TransferJob (v1.0.0)

Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::TransferJob.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#creation_time

def creation_time() -> ::Google::Protobuf::Timestamp
Returns

#deletion_time

def deletion_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — 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.

#event_stream

def event_stream() -> ::Google::Cloud::StorageTransfer::V1::EventStream
Returns

#event_stream=

def event_stream=(value) -> ::Google::Cloud::StorageTransfer::V1::EventStream
Parameter
Returns

#last_modification_time

def last_modification_time() -> ::Google::Protobuf::Timestamp
Returns

#latest_operation_name

def latest_operation_name() -> ::String
Returns
  • (::String) — The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.

#latest_operation_name=

def latest_operation_name=(value) -> ::String
Parameter
  • value (::String) — 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.

#logging_config

def logging_config() -> ::Google::Cloud::StorageTransfer::V1::LoggingConfig
Returns

#logging_config=

def logging_config=(value) -> ::Google::Cloud::StorageTransfer::V1::LoggingConfig
Parameter
Returns

#name

def name() -> ::String
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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.

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.

#notification_config

def notification_config() -> ::Google::Cloud::StorageTransfer::V1::NotificationConfig
Returns

#notification_config=

def notification_config=(value) -> ::Google::Cloud::StorageTransfer::V1::NotificationConfig
Parameter
Returns

#project_id

def project_id() -> ::String
Returns
  • (::String) — The ID of the Google Cloud project that owns the job.

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::String) — The ID of the Google Cloud project that owns the job.
Returns
  • (::String) — The ID of the Google Cloud project that owns the job.

#schedule

def schedule() -> ::Google::Cloud::StorageTransfer::V1::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.

#schedule=

def schedule=(value) -> ::Google::Cloud::StorageTransfer::V1::Schedule
Parameter
  • value (::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.
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.

#status

def status() -> ::Google::Cloud::StorageTransfer::V1::TransferJob::Status
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.

#status=

def status=(value) -> ::Google::Cloud::StorageTransfer::V1::TransferJob::Status
Parameter
  • value (::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.

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.

#transfer_spec

def transfer_spec() -> ::Google::Cloud::StorageTransfer::V1::TransferSpec
Returns

#transfer_spec=

def transfer_spec=(value) -> ::Google::Cloud::StorageTransfer::V1::TransferSpec
Parameter
Returns